PHP Class macgyer\yii2materializecss\widgets\Progress
Use this widget to give the user feedback about the loading of content or if you have actions that require multiple
steps to complete.
There are two types of progress bars available:
- inderterminated with an animated recurring bar
- determinated with a defined length
For an indeterminated progress bar simply add the following
php
To render an determinated progress bar with an initial value set [[value]] to the desired value and
change [[type]] to "determinate"
php
'determinate',
'value' => 10
]) ?>
Exibir arquivo
Open project: macgyer/yii2-materializecss
Public Properties
Property |
Type |
Description |
|
$options |
|
the HTML attributes for the widget container tag |
|
$progressOptions |
|
the HTML attributes for the progress tag. |
|
$type |
|
the type of the progress bar.
The following options are supported:
- indeterminate (default)
- determinate |
|
$value |
|
the (initial) value for 'determinate' progress bars.
The supported range is [0 ... 100].
This value will be applied as inline CSS style to show the progress:
|
|
Public Methods
Method |
Description |
|
init ( ) |
Initializes the widget. |
|
run ( ) : string |
Executes the widget. |
|
Method Details
public run ( ) : string |
return |
string |
the result of widget execution to be outputted. |
Property Details
$options public_oe property
the HTML attributes for the widget container tag
$progressOptions public_oe property
the HTML attributes for the progress tag.
the type of the progress bar.
The following options are supported:
- indeterminate (default)
- determinate
$value public_oe property
the (initial) value for 'determinate' progress bars.
The supported range is [0 ... 100].
This value will be applied as inline CSS style to show the progress: