Class yii\jui\ProgressBar

All Classes | Properties | Methods

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

ProgressBar renders an progressbar jQuery UI widget.

For example:

echo ProgressBar::widget([
    'clientOptions' => [
        'value' => 75,
    ],
]);

The following example will show the content enclosed between the begin() and end() calls within the widget container:

ProgressBar::begin([
    'clientOptions' => ['value' => 75],
]);

echo '<div class="progress-label">Loading...</div>';

ProgressBar::end();

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$clientEventMap	array	Event names mapped to what should be specified in `.on()`.	yii\jui\Widget
$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

Public Methods

Hide inherited methods

Method	Description	Defined By
init()	Initializes the widget.	yii\jui\ProgressBar
run()	Renders the widget.	yii\jui\ProgressBar

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

Method Details

Hide inherited methods

init() public method

Initializes the widget.

public void init ( )

Source code

                public function init()
{
    parent::init();
    echo Html::beginTag('div', $this->options) . "\n";
}

registerClientEvents() protected method

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

Registers a specific jQuery UI widget events

protected void registerClientEvents ( $name, $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 void registerClientOptions ( $name, $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 void registerWidget ( $name, $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

Renders the widget.

public void run ( )

Source code

                public function run()
{
    echo Html::endTag('div') . "\n";
    $this->registerWidget('progressbar');
}