StepItem

API reference › Bootstrap 6 › item › StepItem

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

Represents a Stepper step: a list item, a <div>, or a link when it has a URL.

Properties

Property	Type	Description	Defined by
`$active` readonly constructor	`bool`	Whether the step is completed or current (`.active`). Default: `false`.	`StepItem`
`$description` readonly constructor	`string\|Stringable\|null`	Secondary text rendered under the label, or `null` for none. Default: `null`.	`StepItem`
`$encode` readonly constructor	`bool\|null`	Whether to HTML-encode `$label` and `$description`, or `null` to use `Stepper::$encodeLabels`. Default: `null`.	`StepItem`
`$label` readonly constructor	`string\|Stringable`	Label of the step.	`StepItem`
`$options` readonly constructor	`array<array-key, mixed>`	HTML attributes of the `.stepper-item` element. Default: `[]`.	`StepItem`
`$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`.	`StepItem`
`$url` readonly constructor	`array<array-key, mixed>\|string\|null`	URL processed by `Url::to()`, or `null` for a step without link; any step with a URL renders the stepper as links. Default: `null`.	`StepItem`

Methods

Method	Description	Defined by
`fromArray()` static	Creates a step from the array configuration documented in `Stepper::$items`.	`StepItem`
`to()` static	Creates a step.	`StepItem`
`withActive()`	Returns a copy with the given active state.	`StepItem`
`withDescription()`	Returns a copy with the given description.	`StepItem`
`withEncode()`	Returns a copy with the given encoding flag.	`StepItem`
`withLabel()`	Returns a copy with the given label.	`StepItem`
`withOptions()`	Returns a copy with the given `.stepper-item` attributes.	`StepItem`
`withTheme()`	Returns a copy with the given theme color.	`StepItem`
`withUrl()`	Returns a copy with the given URL.	`StepItem`

Method details

fromArray()

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

Creates a step from the array configuration documented in Stepper::$items.

Only true activates the step and only a bool encode is used; a description, theme, url, or options of another type is ignored.

Parameters

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

Returns

self

Throws

yii\base\InvalidConfigException: if the step has no string|Stringable label, or its theme is a string that is not a Theme value.

to()

public static function to(string|Stringable $label, string|Stringable|null $description = null): self

Creates a step.

Parameters

Parameter	Type	Description
`$label`	`string\|Stringable`	Label of the step.
`$description`	`string\|Stringable\|null`	Secondary text rendered under the label, or `null` for none.

Returns

self

withActive()

public function withActive(bool $active): self

Returns a copy with the given active state.

Parameters

Parameter	Type	Description
`$active`	`bool`

Returns

self

withDescription()

public function withDescription(string|Stringable|null $description): self

Returns a copy with the given description.

Parameters

Parameter	Type	Description
`$description`	`string\|Stringable\|null`

Returns

self

withEncode()

public function withEncode(bool|null $encode): self

Returns a copy with the given encoding flag.

Parameters

Parameter	Type	Description
`$encode`	`bool\|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 .stepper-item attributes.

Parameters

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

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.

withUrl()

public function withUrl(array<array-key, mixed>|string|null $url): self

Returns a copy with the given URL.

Parameters

Parameter	Type	Description
`$url`	`array<array-key, mixed>\|string\|null`	URL processed by `Url::to()`.

Returns

self