Class yii\jui\ProgressBar

Inheritanceyii\jui\ProgressBar » yii\jui\Widget » yii\base\Widget
Available since version2.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();

See also http://api.jqueryui.com/progressbar/.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined 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

PropertyTypeDescriptionDefined By
$clientEventMap array Event names mapped to what should be specified in `. yii\jui\Widget

Public Methods

Hide inherited methods

MethodDescriptionDefined By
init() Initializes the widget. yii\jui\ProgressBar
run() Renders the widget. yii\jui\ProgressBar

Protected Methods

Hide inherited methods

MethodDescriptionDefined 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

init() public method

Initializes the widget.

public void init ( )
run() public method

Renders the widget.

public void run ( )