yii2-dual-listbox ¶

1. Description
2. Requirements
3. Installation
4. Usage
5. Properties of softark\duallistbox\DualListbox
6. Source Code & Download
7. History

Dual Listboxt for Yii framework 2.0.

Description ¶

softark\duallistbox\DualListbox widget is a Yii 2 wrapper for Bootstrap Dual Listbox.

Requirements ¶

• Yii Version 2.0.0 or later

Installation ¶

Add softark/yii2-dual-listbox in your project's composer.json, and let Composer configure your project.

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

Usage ¶

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

• Replacing Html::listBox() using name and selection

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',
        ],
    ]);
?>

• Replacing Html::activeListBox() using model and attribute

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',
        ],
    ]);
?>

• Replacing ActiveField::listBox() using model and attribute

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',
        ],
    ]);
?>

And 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.

Properties of softark\duallistbox\DualListbox ¶

1. name @var string

   The input name.

2. selection @var array

   The selected values.

3. model @var yii\base\Model

   The model object.

4. attribute @var string

   The attribute name.

5. items @var array

   The option data items. The array keys are option values, and the array values are the corresponding option labels.

6. options @var array

   The tag options for the listbox in terms of name-value pairs.

7. clientOptions @var array

   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.

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

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().

When you use model-attribute pair, the target attribute should be an array. Take a look at the following wiki for detailed information.

How to use Listbox and CheckboxList

Source Code & Download ¶

• Github Repository

History ¶

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