ProgressBar

API reference › Bootstrap 6 › item › ProgressBar

final readonly class	`yii2\extensions\bootstrap6\item\ProgressBar`
Uses traits	`ItemTrait`
Source	`src/item/ProgressBar.php`

Represents a Progress bar: the single bar, or a segment of a stacked bar.

The range of $percent depends on the widget min and max, so the widget validates it when rendering.

Properties

Property	Type	Description	Defined by
`$animated` readonly constructor	`bool`	Whether to animate the stripes (`progress-bar-animated`). Default: `false`.	`ProgressBar`
`$ariaLabel` readonly constructor	`string\|null`	Accessible name rendered as `aria-label`, or `null` to omit it. Default: `null`.	`ProgressBar`
`$label` readonly constructor	`string\|Stringable`	Content of the `.progress-bar` element. Default: `''`.	`ProgressBar`
`$options` readonly constructor	`array<array-key, mixed>`	HTML attributes of the `.progress-bar` element. Default: `[]`.	`ProgressBar`
`$percent` readonly constructor	`float\|int`	Current value, between the widget `min` and `max`.	`ProgressBar`
`$striped` readonly constructor	`bool`	Whether to render stripes (`progress-bar-striped`). Default: `false`.	`ProgressBar`
`$theme` readonly constructor	`yii2\extensions\bootstrap6\enum\Theme\|string\|null`	Theme color rendered as the `theme-{value}` class, or `null` for the default. Default: `null`.	`ProgressBar`

Methods

Method	Description	Defined by
`fromArray()` static	Creates a bar from the array configuration documented in `Progress::$bars`.	`ProgressBar`
`to()` static	Creates a bar.	`ProgressBar`
`withAnimated()`	Returns a copy with the given stripe animation flag.	`ProgressBar`
`withAriaLabel()`	Returns a copy with the given accessible name.	`ProgressBar`
`withLabel()`	Returns a copy with the given label.	`ProgressBar`
`withOptions()`	Returns a copy with the given `.progress-bar` attributes.	`ProgressBar`
`withPercent()`	Returns a copy with the given value.	`ProgressBar`
`withStriped()`	Returns a copy with the given stripes flag.	`ProgressBar`
`withTheme()`	Returns a copy with the given theme color.	`ProgressBar`

Method details

fromArray()

public static function fromArray(array<array-key, mixed> $config): self

Creates a bar from the array configuration documented in Progress::$bars.

Only true enables striped and animated; a label, theme, ariaLabel, or options of another type is ignored.

Parameters

Parameter	Type	Description
`$config`	`array<array-key, mixed>`	Bar configuration.

Returns

self

Throws

yii\base\InvalidConfigException: if the bar has no float|int percent, or its theme is a string that is not a Theme value.

to()

public static function to(float|int $percent, string|Stringable $label = ''): self

Creates a bar.

Parameters

Parameter	Type	Description
`$percent`	`float\|int`	Current value, between the widget `min` and `max`.
`$label`	`string\|Stringable`	Content of the `.progress-bar` element.

Returns

self

withAnimated()

public function withAnimated(bool $animated): self

Returns a copy with the given stripe animation flag.

Parameters

Parameter	Type	Description
`$animated`	`bool`

Returns

self

withAriaLabel()

public function withAriaLabel(string|null $ariaLabel): self

Returns a copy with the given accessible name.

Parameters

Parameter	Type	Description
`$ariaLabel`	`string\|null`

Returns

self

withLabel()

public function withLabel(string|Stringable $label): self

Returns a copy with the given label.

Parameters

Parameter	Type	Description
`$label`	`string\|Stringable`

Returns

self

withOptions()

public function withOptions(array<array-key, mixed> $options): self

Returns a copy with the given .progress-bar attributes.

Parameters

Parameter	Type	Description
`$options`	`array<array-key, mixed>`	HTML attributes of the `.progress-bar` element.

Returns

self

withPercent()

public function withPercent(float|int $percent): self

Returns a copy with the given value.

Parameters

Parameter	Type	Description
`$percent`	`float\|int`

Returns

self

withStriped()

public function withStriped(bool $striped): self

Returns a copy with the given stripes flag.

Parameters

Parameter	Type	Description
`$striped`	`bool`

Returns

self

withTheme()

public function withTheme(yii2\extensions\bootstrap6\enum\Theme|string|null $theme): self

Returns a copy with the given theme color.

Parameters

Parameter	Type	Description
`$theme`	`yii2\extensions\bootstrap6\enum\Theme\|string\|null`

Returns

self

Throws

yii\base\InvalidConfigException: if $theme is a string that is not a Theme value.