Download the PHP package softark/yii2-dual-listbox without Composer
On this page you can find all versions of the php package softark/yii2-dual-listbox. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download softark/yii2-dual-listbox
More information about softark/yii2-dual-listbox
Files in softark/yii2-dual-listbox
Package yii2-dual-listbox
Short Description Bootstrap Dual Listbox Widget for Yii 2
License BSD-3-Clause
Informations about the package yii2-dual-listbox
yii2-dual-listbox
Dual Listboxt for Yii framework 2.0.
Description
softark\duallistbox\DualListbox widget is a Yii 2 wrapper for Bootstrap Dual Listbox.
It works with bootstrap 3, 4, or 5
Requirements
- Yii Version 2.0.0 or later
- yii2-bootstrap, yii2-bootstrap4 or yii2-bootstrap5
- istvan-ujjmeszaros/bootstrap-duallistbox v.3.0.x or v.4.0.x
Usage
-
Add
softark/yii2-dual-listbox
andistvan-ujjmeszaros/bootstrap-duallistbox
in your project'scomposer.json
, and let Composer configure your project.- You have to use a different version of
istvan-ujjmeszaros/bootstrap-duallistbox
depending on the bootstrap version. -
For bootstrap 3, use
~3.0.0
: - For bootstrap 4 and 5, use
~4.0.0
:
- You have to use a different version of
-
Use
softark\duallistbox\DualListbox::widget()
in place ofyii\helpers\Html::listBox()
,yii\helpers\Html::activeListBox()
, oryii\widgets\ActiveField::listBox()
in your view.-
Replacing Html::listBox() using name and selection
-
Replacing Html::activeListBox() using model and attribute
- Replacing ActiveField::listBox() using model and attribute
-
-
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.
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.
Properties of softark\duallistbox\DualListbox
-
name @var string
The input name.
-
selection @var array
The selected values.
-
model @var yii\base\Model
The model object.
-
attribute @var string
The attribute name.
-
items @var array
The option data items. The array keys are option values, and the array values are the corresponding option labels.
-
options @var array
The tag options for the listbox in terms of name-value pairs.
-
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()
.
Notice
For some reason, Bootstrap Dual Listbox doesn't work in mobile device browsers, and so you can not use this widget for them.
Consider using checkbox list instead.
History
- Version 1.0.0 (2016-01-12)
- Tested on Yii 2.0.6
- Version 1.0.1 (2020-09-18)
- Supports both bootstrap3 and bootstrap4
- Version 1.0.2 (2022-09-08)
- Supports also bootstrap5