Progress

API reference › Bootstrap 6 › Progress

class	`yii2\extensions\bootstrap6\Progress`
Extends	`Widget` » `yii\base\Widget` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\ViewContextInterface`, `yii\base\Configurable`
Uses traits	`AttributesTrait`, `BootstrapWidgetTrait`
Source	`src/Progress.php`

Renders a Bootstrap progress bar, or a stacked progress bar when $bars is set.

The .progress element carries role="progressbar" and the aria-value* attributes; in stacked mode each segment is a .progress element sized by its width inside a .progress-stacked container.

Properties

Property	Type	Description	Defined by
`$animated`	`bool`	Whether to animate the stripes (`progress-bar-animated`) of the single bar. Default: `false`.	`Progress`
`$ariaLabel`	`string\|null`	Accessible name of the single bar rendered as `aria-label`, or `null` to omit it. Default: `null`.	`Progress`
`$autoIdPrefix` static	`string`	The prefix to the automatically generated widget IDs. Default: `'w'`.	`yii\base\Widget`
`$barOptions`	`array<string, mixed>`	HTML attributes of the single `.progress-bar` tag. Default: `[]`.	`Progress`
`$bars`	`list<array<string, mixed>\|yii2\extensions\bootstrap6\item\ProgressBar>`	Segments of a stacked progress bar: `ProgressBar` instances, or arrays converted through `ProgressBar::fromArray()`; when not empty, the single bar properties are ignored. Default: `[]`.	`Progress`
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$clientEvents`	`array<string,` `yii\web\JsExpression\|string>`	Event handlers attached to the widget element, as event name => JavaScript handler source. Default: `[]`.	`BootstrapWidgetTrait`
`$clientOptions`	`array<string, mixed>\|false`	Options passed to the plugin constructor, or `false` to skip the JavaScript initialization. Default: `[]`.	`BootstrapWidgetTrait`
`$encodeLabel`	`bool`	Whether to HTML-encode the bar labels. Default: `true`.	`Progress`
`$id`	`string`	Id of the widget.	`yii\base\Widget`
`$label`	`string\|Stringable`	Label of the single bar. Default: `''`.	`Progress`
`$max`	`float\|int`	Maximum value rendered as `aria-valuemax`. Default: `100`.	`Progress`
`$min`	`float\|int`	Minimum value rendered as `aria-valuemin`. Default: `0`.	`Progress`
`$options`	`array<string, mixed>`	HTML attributes of the widget container tag. Default: `[]`.	`Widget`
`$percent`	`float\|int`	Current value of the single bar, between `$min` and `$max`. Default: `0`.	`Progress`
`$striped`	`bool`	Whether to render stripes (`progress-bar-striped`) on the single bar. Default: `false`.	`Progress`
`$theme`	`yii2\extensions\bootstrap6\enum\Theme\|string\|null`	Theme color of the single bar rendered as the `theme-{value}` class, or `null` for the default color. Default: `null`.	`Progress`
`$view`	`yii\web\View`	The view object that can be used to render views or view files.	`yii\base\Widget`
`$viewPath` read-only	`string`	The directory containing the view files for this widget.	`yii\base\Widget`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__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`
`__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`
`addAttributes()`	Adds a set of HTML attributes; attributes already set with the same name are replaced.	`AttributesTrait`
`addClass()`	Adds one or more CSS classes to the existing classes; duplicated classes are collapsed.	`AttributesTrait`
`addCssStyle()`	Adds CSS style properties to the `style` attribute.	`AttributesTrait`
`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`
`attribute()`	Sets an HTML attribute value.	`AttributesTrait`
`beforeRun()`	This method is invoked right before the widget is executed.	`yii\base\Widget`
`begin()` static	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`
`class()`	Replaces the existing CSS classes with the specified ones.	`AttributesTrait`
`className()` static	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()` static	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 and validates `$max` and `$theme`.	`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()`		`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()` static	Creates a widget instance and runs it.	`yii\base\Widget`
`pluginInitialization()` protected	Returns the JavaScript that initializes a plugin with its normalized constructor options.	`BootstrapWidgetTrait`
`registerClientEvents()` protected	Registers the JavaScript event handlers listed in `$clientEvents` at `View::POS_END`.	`BootstrapWidgetTrait`
`registerPlugin()` protected	Registers the plugin asset, the plugin initialization when needed, and the `$clientEvents`.	`BootstrapWidgetTrait`
`renderProgress()` protected	Renders a `.progress` element with its `.progress-bar`.	`Progress`

Events

Event	Type	Description	Defined by
`EVENT_INIT`	`yii\base\Event`	An event that is triggered when the widget is initialized via `init()`. Event name: `'init'`. Available since 2.0.11.	`yii\base\Widget`
`EVENT_BEFORE_RUN`	`yii\base\WidgetEvent`	An event raised right before executing a widget. Event name: `'beforeRun'`. Available since 2.0.11.	`yii\base\Widget`
`EVENT_AFTER_RUN`	`yii\base\WidgetEvent`	An event raised right after executing a widget. Event name: `'afterRun'`. Available since 2.0.11.	`yii\base\Widget`

Property details

$bars

public list<array<string, mixed>|yii2\extensions\bootstrap6\item\ProgressBar> $bars = []

Segments of a stacked progress bar: ProgressBar instances, or arrays converted through ProgressBar::fromArray(); when not empty, the single bar properties are ignored.

An array segment supports the keys percent (required), label, theme, striped, animated, ariaLabel, and options (HTML attributes of the segment .progress-bar tag), with the meaning of the matching properties.

Method details

init()

public function init(): void

Initializes the widget and validates $max and $theme.

Segments in $bars are converted and validated when the widget runs.

Throws

yii\base\InvalidConfigException: if $max is not greater than $min, or $theme is not a Theme value.

run()

public function run(): string

Returns

string

Throws

yii\base\InvalidArgumentException: if a value is outside the [$min, $max] range.
yii\base\InvalidConfigException: if a stacked segment has no numeric percent or an invalid theme.

renderProgress()

protected function renderProgress(yii2\extensions\bootstrap6\item\ProgressBar $bar, array<string, mixed> $options, bool $stacked): string

Renders a .progress element with its .progress-bar.

Parameters

Parameter	Type	Description
`$bar`	`yii2\extensions\bootstrap6\item\ProgressBar`	Bar to render; the single bar is built from the widget properties.
`$options`	`array<string, mixed>`	HTML attributes of the `.progress` tag.
`$stacked`	`bool`	Whether the bar is a stacked segment, sized on the `.progress` element.

Returns

string

Throws

yii\base\InvalidArgumentException: if the value is outside the [$min, $max] range.