Class yii\bootstrap5\Progress

All Classes | Properties | Methods | Events

Inheritance	yii\bootstrap5\Progress » yii\bootstrap5\Widget » yii\base\Widget » yii\base\Component » yii\base\BaseObject
Implements	yii\base\Configurable, yii\base\ViewContextInterface
Uses Traits	yii\bootstrap5\BootstrapWidgetTrait
Source Code	https://github.com/yiisoft/yii2/blob/master/framework/bootstrap5/Progress.php

Progress renders a bootstrap progress bar component.

For example,

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

// styled
echo Progress::widget([
    'percent' => 65,
    'barOptions' => ['class' => 'bg-danger']
]);
// or
echo Progress::widget([
    'bars' => [
        ['percent' => 65, 'options' => ['class' => 'bg-danger']]
    ]
]);

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

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

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

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\bootstrap5\Progress
$bars	array	A set of bars that are stacked together to form a single progress bar.	yii\bootstrap5\Progress
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component.	yii\base\Component
$clientEvents	array	The event handlers for the underlying Bootstrap JS plugin.	yii\bootstrap5\BootstrapWidgetTrait
$clientOptions	array\|boolean	The options for the underlying Bootstrap JS plugin.	yii\bootstrap5\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\bootstrap5\Progress
$options	array	The HTML attributes for the widget container tag.	yii\bootstrap5\Widget
$percent	integer	The amount of progress as a percentage.	yii\bootstrap5\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.	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()	Returns the view object that can be used to render views or view files.	yii\base\Widget
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\bootstrap5\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()	Executes the widget.	yii\bootstrap5\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\bootstrap5\BootstrapWidgetTrait
registerPlugin()	Registers a specific Bootstrap plugin and the related events	yii\bootstrap5\BootstrapWidgetTrait
renderBar()	Generates a progress bar.	yii\bootstrap5\Progress
renderProgress()	Renders the progress.	yii\bootstrap5\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 (available since version 2.0.6)

The HTML attributes of the bar. This property will only be considered if $bars is empty

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. This property will only be considered if $bars is empty

public string $label = null

$percent public property

The amount of progress as a percentage. This property will only be considered if $bars is empty

public integer $percent = 0

Method Details

init() public method

Initializes the widget.

This method will register the bootstrap asset bundle. If you override this method, make sure you call the parent implementation first.

public void init ( )
throws	yii\base\InvalidConfigException

renderBar() protected method

Generates a progress bar.

protected string renderBar ( \yii\bootstrap5\int $percent, \yii\bootstrap5\string $label = '', array $options = [] )
$percent	integer	The percentage of the bar
$label	string	Optional, the label to display at the bar
$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.
throws	Exception

run() public method

Executes the widget.

public string\|void run ( )
return	string\|void	The rendering result may be directly "echoed" or returned as a string
throws	yii\base\InvalidConfigException