vorobyev/test

Dual Listbox Widget for Yii 2

yii2-dual-listbox

Dual Listboxt for Yii framework 2.0., _(*1)

Description

softark\duallistbox\DualListbox widget is a Yii 2 wrapper for Bootstrap Dual Listbox., _(*2)

Requirements

• Yii Version 2.0.0 or later

Usage

1. Add softark/yii2-dual-listbox in your project's composer.json, and let Composer configure your project., _(*3)

   "require": {
       "php": ">=5.4.0",
       "yiisoft/yii2": "*",
       "yiisoft/yii2-bootstrap": "*",
       "yiisoft/yii2-swiftmailer": "*",
       "softark/yii2-dual-listbox": "dev-master"
   },
   

2. Use softark\duallistbox\DualListbox::widget() in place of yii\helpers\Html::listBox(), yii\helpers\Html::activeListBox(), or yii\widgets\ActiveField::listBox() in your view., _(*4)

   1. Replacing Html::listBox() using name and selection, _(*5)

      use softark\duallistbox\DualListbox;
      ...
      <?php
          $options = [
              'multiple' => true,
              'size' => 20,
          ];
          // echo Html::listBox($name, $selection, $items, $options);
          echo DualListbox::widget([
              'name' => $name,
              'selection' => $selection,
              'items' => $items,
              'options' => $options,
              'clientOptions' => [
                  'moveOnSelect' => false,
                  'selectedListLabel' => 'Selected Items',
                  'nonSelectedListLabel' => 'Available Items',
              ],
          ]);
      ?>
      

   2. Replacing Html::activeListBox() using model and attribute, _(*6)

      use softark\duallistbox\DualListbox;
      ...
      <?php
          $options = [
              'multiple' => true,
              'size' => 20,
          ];
          // echo Html::activeListBox($model, $attribute, $items, $options);
          echo DualListbox::widget([
              'model' => $model,
              'attribute' => $attribute,
              'items' => $items,
              'options' => $options,
              'clientOptions' => [
                  'moveOnSelect' => false,
                  'selectedListLabel' => 'Selected Items',
                  'nonSelectedListLabel' => 'Available Items',
              ],
          ]);
      ?>
      

   3. Replacing ActiveField::listBox() using model and attribute, _(*7)

      use softark\duallistbox\DualListbox;
      ...
      <?php
          $options = [
              'multiple' => true,
              'size' => 20,
          ];
          // echo $form->field($model, $attribute)->listBox($items, $options);
          echo $form->field($model, $attribute)->widget(DualListbox::className(),[
              'items' => $items,
              'options' => $options,
              'clientOptions' => [
                  'moveOnSelect' => false,
                  'selectedListLabel' => 'Selected Items',
                  'nonSelectedListLabel' => 'Available Items',
              ],
          ]);
      ?>
      

3. Collect the user input in the server side, just as you do with a single Listbox with multiple selection. Note that the input value will be an array., _(*8)

   If you find difficulty in handling the user input, please read A Sample Code which demonstrates how to use a dual listbox to the data in array format., _(*9)

Properties of softark\duallistbox\DualListbox

1. name @var string, _(*10)

   The input name., _(*11)

2. selection @var array, _(*12)

   The selected values., _(*13)

3. model @var yii\base\Model, _(*14)

   The model object., _(*15)

4. attribute @var string, _(*16)

   The attribute name., _(*17)

5. items @var array, _(*18)

   The option data items. The array keys are option values, and the array values are the corresponding option labels., _(*19)

6. options @var array, _(*20)

   The tag options for the listbox in terms of name-value pairs., _(*21)

7. clientOptions @var array, _(*22)

   The options for the Bootstrap Dual Listbox in terms of name-value pairs. See Initialzation parameters object section of the official documentation of Bootstrap Dual Listbox for details., _(*23)

The first 6 properties correspond to the parameters used in Html::listBox(), Html::activeListBox() and ActiveField::listBox()., _(*24)

Note that you have to use either name-selection pair or model-attribute pair. The former is for replacing Html::listBox() and the latter is for Html::activeListBox() and ActiveField::listBox()., _(*25)

History

• Version 1.0.0 (2016-01-12)
  • Tested on Yii 2.0.6