Class yii\jui\Slider

All Classes | Properties | Methods

Inheritance	yii\jui\Slider » yii\jui\Widget » yii\base\Widget
Available since extension's version	2.0
Source Code	https://github.com/yiisoft/yii2-jui/blob/master/Slider.php

Slider renders a slider jQuery UI widget.

echo Slider::widget([
    'clientOptions' => [
        'min' => 1,
        'max' => 10,
    ],
]);

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$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
$options	array	The HTML attributes for the widget container tag.	yii\jui\Widget

Protected Properties

Hide inherited properties

Property	Type	Description	Defined By
$clientEventMap		Event names mapped to what should be specified in `.on()`.	yii\jui\Slider

Public Methods

Hide inherited methods

Method	Description	Defined By
init()	Initializes the widget.	yii\jui\Widget
run()	Executes the widget.	yii\jui\Slider

Protected Methods

Hide inherited methods

Method	Description	Defined By
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

Hide inherited properties

$clientEventMap protected property

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 $clientEventMap = [
    'change' => 'slidechange',
    'create' => 'slidecreate',
    'slide' => 'slide',
    'start' => 'slidestart',
    'stop' => 'slidestop',
]

Method Details

Hide inherited methods

init() public method

Defined in: yii\jui\Widget::init()

Initializes the widget.

If you override this method, make sure you call the parent implementation first.

public mixed init ( )

Source code

                public function init()
{
    parent::init();
    if (!isset($this->options['id'])) {
        $this->options['id'] = $this->getId();
    }
}

registerClientEvents() protected method

Defined in: yii\jui\Widget::registerClientEvents()

Registers a specific jQuery UI widget events

protected mixed registerClientEvents ( string $name, string $id )
$name	string	The name of the jQuery UI widget
$id	string	The ID of the widget

Source code

                protected function registerClientEvents($name, $id)
{
    if (!empty($this->clientEvents)) {
        $js = [];
        foreach ($this->clientEvents as $event => $handler) {
            if (isset($this->clientEventMap[$event])) {
                $eventName = $this->clientEventMap[$event];
            } else {
                $eventName = strtolower($name . $event);
            }
            $js[] = "jQuery('#$id').on('$eventName', $handler);";
        }
        $this->getView()->registerJs(implode("\n", $js));
    }
}

registerClientOptions() protected method

Defined in: yii\jui\Widget::registerClientOptions()

Registers a specific jQuery UI widget options

protected mixed registerClientOptions ( string $name, string $id )
$name	string	The name of the jQuery UI widget
$id	string	The ID of the widget

Source code

                protected function registerClientOptions($name, $id)
{
    if ($this->clientOptions !== false) {
        $options = empty($this->clientOptions) ? '' : Json::htmlEncode($this->clientOptions);
        $js = "jQuery('#$id').$name($options);";
        $this->getView()->registerJs($js);
    }
}

registerWidget() protected method

Defined in: yii\jui\Widget::registerWidget()

Registers a specific jQuery UI widget asset bundle, initializes it with client options and registers related events

protected mixed registerWidget ( string $name, string $id = null )
$name	string	The name of the jQuery UI widget
$id	string	The ID of the widget. If null, it will use the `id` value of $options.

Source code

                protected function registerWidget($name, $id = null)
{
    if ($id === null) {
        $id = $this->options['id'];
    }
    JuiAsset::register($this->getView());
    $this->registerClientEvents($name, $id);
    $this->registerClientOptions($name, $id);
}

run() public method

Executes the widget.

public mixed run ( )

Source code

                public function run()
{
    echo Html::tag('div', '', $this->options);
    $this->registerWidget('slider');
}