Class yii\jui\ProgressBar

All Classes | Properties | Methods

Inheritance	yii\jui\ProgressBar » yii\jui\Widget » yii\base\Widget
Available since version	2.0

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 \yii\jui\begin() and \yii\jui\end() calls within the widget container:

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

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

ProgressBar::end();

Public 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

Property	Type	Description	Defined By
$clientEventMap	array	Event names mapped to what should be specified in `.	yii\jui\Widget

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

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

init() public method

Initializes the widget.

public void init ( )

run() public method

Renders the widget.

public void run ( )