nterms/yii2-listjs-widget

List.js widget for Yii2

yii2-listjs-widget

List.js widget for Yii2. This widget makes List.js functionality available on any list or table in Yii2 applications. Visit List.js website for more info and examples., _(*1)

Installation

The preferred way to install this extension is through composer., _(*2)

Either run, _(*3)

php composer.phar require --prefer-dist nterms/yii2-listjs-widget "*"

or add, _(*4)

"nterms/yii2-listjs-widget": "*"

to the require section of your composer.json file., _(*5)

Usage

Once the extension is installed, simply use it in your code by :, _(*6)

= \nterms\listjs\ListJs::begin([
    'id' => 'days-list',
    'search' => true,
    'sort' => [
        'name' => [
            'label' => Yii::t('app', 'Sort by name'),
        ],
    ],
    'clientOptions' => [
        'valueNames' => ['name'],
    ],
]); ?>

• Sunday
• Monday
• Tuesday
• Wednesday
• Thursday
• Friday
• Saturday

Configurations

Following properties are available for customizing the widget., _(*7)

• options: HTML attributes for the container element.
• search: Whether to show the search field.
• searchOptions: HTML attributes (name-value pairs) for the search input tag.

• sort: list of name-value pairs for rendering the sorting buttons list. Value being the HTML attributes for the button. Special parameter label is used as the button text, _(*8)

  ...
  'sort' => [
   'name' => [
       'class' => 'sort',
       'label' => Yii::t('app', 'Sort by name'),
   ],
  ],
  ...
  
  

• clientOptions: Options for List.js. Read this for list of options.
• content: HTML content, preferably a list or table. If the widget is used in content capturing mode this will be ignored.
• view: Name of the view file to render the content. If the widget is used in content capturing mode or a string is assigned to content property this will be ignored.
• viewParams: Parameters to be passed to view when it is being rendered. This property is used only when view is rendered to generate the content of the widget.

License

MIT, _(*9)