Class yii\jui\SliderInput
Inheritance | yii\jui\SliderInput » yii\jui\InputWidget » yii\jui\Widget » yii\base\Widget |
---|---|
Available since version | 2.0 |
SliderInput renders a slider jQuery UI widget that writes its value into hidden input.
For example,
echo SliderInput::widget([
'model' => $model,
'attribute' => 'amount',
'clientOptions' => [
'min' => 1,
'max' => 10,
],
]);
The following example will use the name property instead:
echo SliderInput::widget([
'name' => 'amount',
'clientOptions' => [
'min' => 1,
'max' => 10,
],
]);
You can also use this widget in an \yii\jui\yii\widgets\ActiveForm using the \yii\jui\yii\widgets\ActiveField::widget() method, for example like this:
<?= $form->field($model, 'from_date')->widget(\yii\jui\SliderInput::classname(), [
'clientOptions' => [
'min' => 1,
'max' => 10,
],
]) ?>
See also http://api.jqueryui.com/slider/.
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$attribute | string | The model attribute that this widget is associated with. | yii\jui\InputWidget |
$clientEvents | array | The event handlers for the underlying jQuery UI widget. | yii\jui\Widget |
$clientOptions | array | The options for the underlying jQuery UI widget. | yii\jui\Widget |
$containerOptions | array | The HTML attributes for the container tag. | yii\jui\SliderInput |
$model | \yii\base\Model | The data model that this widget is associated with. | yii\jui\InputWidget |
$name | string | The input name. | yii\jui\InputWidget |
$options | array | The HTML attributes for the widget container tag. | yii\jui\Widget |
$value | string | The input value. | yii\jui\InputWidget |
Protected Properties
Property | Type | Description | Defined By |
---|---|---|---|
$clientEventMap | array | Event names mapped to what should be specified in `. | yii\jui\SliderInput |
Public Methods
Method | Description | Defined By |
---|---|---|
init() | Initializes the widget. | yii\jui\SliderInput |
run() | Executes the widget. | yii\jui\SliderInput |
Protected Methods
Method | Description | Defined By |
---|---|---|
hasModel() | yii\jui\InputWidget | |
registerClientEvents() | Registers a specific jQuery UI widget events | yii\jui\Widget |
registerClientOptions() | Registers a specific jQuery UI widget options | yii\jui\Widget |
registerWidget() | Registers a specific jQuery UI widget asset bundle, initializes it with client options and registers related events | yii\jui\Widget |
Property Details
Event names mapped to what should be specified in .on()
.
If empty, it is assumed that event passed to clientEvents is prefixed with widget name.
protected array $clientEventMap = ['change' => 'slidechange', 'create' => 'slidecreate', 'slide' => 'slide', 'start' => 'slidestart', 'stop' => 'slidestop']
The HTML attributes for the container tag.
See also \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.