# Class yii\bootstrap\Progress

Inheritance | yii\bootstrap\Progress » yii\bootstrap\Widget » yii\base\Widget » yii\base\Component » yii\base\BaseObject
Implements | yii\base\Configurable, yii\base\ViewContextInterface
Uses Traits | yii\bootstrap\BootstrapWidgetTrait
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2-bootstrap/blob/master/Progress.php

Progress renders a bootstrap progress bar component.

For example,

    // default with label
    echo Progress::widget([
        'percent' => 60,
        'label' => 'test',
    ]);

    // styled
    echo Progress::widget([
        'percent' => 65,
        'barOptions' => ['class' => 'progress-bar-danger']
    ]);

    // striped
    echo Progress::widget([
        'percent' => 70,
        'barOptions' => ['class' => 'progress-bar-warning'],
        'options' => ['class' => 'progress-striped']
    ]);

    // striped animated
    echo Progress::widget([
        'percent' => 70,
        'barOptions' => ['class' => 'progress-bar-success'],
        'options' => ['class' => 'active progress-striped']
    ]);

    // stacked bars
    echo Progress::widget([
        'bars' => [
            ['percent' => 30, 'options' => ['class' => 'progress-bar-danger']],
            ['percent' => 30, 'label' => 'test', 'options' => ['class' => 'progress-bar-success']],
            ['percent' => 35, 'options' => ['class' => 'progress-bar-warning']],
        ]
    ]);

See also http://getbootstrap.com/components/#progress.

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$autoIdPrefix | string | The prefix to the automatically generated widget IDs. | yii\base\Widget
$barOptions | array | The HTML attributes of the bar. | yii\bootstrap\Progress
$bars | array | A set of bars that are stacked together to form a single progress bar. | yii\bootstrap\Progress
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. This property is read-only. | yii\base\Component
$clientEvents | array | The event handlers for the underlying Bootstrap JS plugin. | yii\bootstrap\BootstrapWidgetTrait
$clientOptions | array | The options for the underlying Bootstrap JS plugin. | yii\bootstrap\BootstrapWidgetTrait
$counter | integer | A counter used to generate $id for widgets. | yii\base\Widget
$id | string|null | ID of the widget. Note that the type of this property differs in getter and setter. See getId() and setId() for details. | yii\base\Widget
$label | string | The button label. | yii\bootstrap\Progress
$options | array | The HTML attributes for the widget container tag. | yii\bootstrap\Widget
$percent | integer | The amount of progress as a percentage. | yii\bootstrap\Progress
$stack | yii\base\Widget[] | The widgets that are currently being rendered (not ended). | yii\base\Widget
$view | yii\web\View | The view object that can be used to render views or view files. Note that the type of this property differs in getter and setter. See getView() and setView() for details. | yii\base\Widget
$viewPath | string | The directory containing the view files for this widget. This property is read-only. | yii\base\Widget

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
__call() | Calls the named method which is not a class method. | yii\base\Component
__clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component
__construct() | Constructor. | yii\base\BaseObject
__get() | Returns the value of a component property. | yii\base\Component
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component
__set() | Sets the value of a component property. | yii\base\Component
__unset() | Sets a component property to be null. | yii\base\Component
afterRun() | This method is invoked right after a widget is executed. | yii\base\Widget
attachBehavior() | Attaches a behavior to this component. | yii\base\Component
attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component
beforeRun() | This method is invoked right before the widget is executed. | yii\base\Widget
begin() | Begins a widget. | yii\base\Widget
behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component
className() | Returns the fully qualified name of this class. | yii\base\BaseObject
detachBehavior() | Detaches a behavior from the component. | yii\base\Component
detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component
end() | Ends a widget. | yii\base\Widget
ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component
getBehavior() | Returns the named behavior object. | yii\base\Component
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component
getId() | Returns the ID of the widget. | yii\base\Widget
getView() |  | yii\bootstrap\BootstrapWidgetTrait
getViewPath() | Returns the directory containing the view files for this widget. | yii\base\Widget
hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component
hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component
init() | Initializes the widget. | yii\bootstrap\Progress
off() | Detaches an existing event handler from this component. | yii\base\Component
on() | Attaches an event handler to an event. | yii\base\Component
render() | Renders a view. | yii\base\Widget
renderFile() | Renders a view file. | yii\base\Widget
run() | Renders the widget. | yii\bootstrap\Progress
setId() | Sets the ID of the widget. | yii\base\Widget
setView() | Sets the view object to be used by this widget. | yii\base\Widget
trigger() | Triggers an event. | yii\base\Component
widget() | Creates a widget instance and runs it. | yii\base\Widget

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
registerClientEvents() | Registers JS event handlers that are listed in $clientEvents. | yii\bootstrap\BootstrapWidgetTrait
registerPlugin() | Registers a specific Bootstrap plugin and the related events | yii\bootstrap\BootstrapWidgetTrait
renderBar() | Generates a bar | yii\bootstrap\Progress
renderProgress() | Renders the progress. | yii\bootstrap\Progress

## Events

Hide inherited events

Event | Type | Description | Defined By
--- | --- | --- | ---
EVENT_AFTER_RUN | yii\base\WidgetEvent | An event raised right after executing a widget. (available since version 2.0.11) | yii\base\Widget
EVENT_BEFORE_RUN | yii\base\WidgetEvent | An event raised right before executing a widget. (available since version 2.0.11) | yii\base\Widget
EVENT_INIT | yii\base\Event | An event that is triggered when the widget is initialized via init(). (available since version 2.0.11) | yii\base\Widget

## Property Details

$barOptions public property

The HTML attributes of the bar.

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $barOptions = []
$bars public property

A set of bars that are stacked together to form a single progress bar. Each bar is an array of the following structure:

    [
        // required, the amount of progress as a percentage.
        'percent' => 30,
        // optional, the label to be displayed on the bar
        'label' => '30%',
        // optional, array, additional HTML attributes for the bar tag
        'options' => [],
    ]

public array $bars = null
$label public property

The button label.

public string $label = null
$percent public property

The amount of progress as a percentage.

public integer $percent = 0

## Method Details

init() public method

Initializes the widget.

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

public void init ( )

renderBar() protected method

Generates a bar

protected string renderBar ( $percent, $label = '', $options = [] )
$percent | integer | The percentage of the bar
$label |  |
$options | array | The HTML attributes of the bar
return | string | The rendering result.

renderProgress() protected method

Renders the progress.

protected string renderProgress ( )
return | string | The rendering result.
throws | yii\base\InvalidConfigException | if the "percent" option is not set in a stacked progress bar.

run() public method

Renders the widget.

public void run ( )