CarouselItem

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

Represents a Carousel slide: a .carousel-item element with its content.

Properties

Property	Type	Description	Defined by
`$content` readonly constructor	`string\|Stringable`	Content of the slide (not encoded).	`CarouselItem`
`$options` readonly constructor	`array<array-key, mixed>`	HTML attributes of the `.carousel-item` element. Default: `[]`.	`CarouselItem`

Method	Description	Defined by
`fromArray()` static	Creates a slide from the array configuration documented in `Carousel::$items`.	`CarouselItem`
`to()` static	Creates a slide.	`CarouselItem`
`withContent()`	Returns a copy with the given content.	`CarouselItem`
`withOptions()`	Returns a copy with the given `.carousel-item` attributes.	`CarouselItem`

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

Creates a slide from the array configuration documented in Carousel::$items.

An options key that is not an array is ignored.

Parameters

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

Returns

self

Throws

yii\base\InvalidConfigException: if the slide has no string|Stringable content.

public static function to(string|Stringable $content): self

Creates a slide.

Parameters

Parameter	Type	Description
`$content`	`string\|Stringable`	Content of the slide (not encoded).

Returns

self

public function withContent(string|Stringable $content): self

Returns a copy with the given content.

Parameters

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

Returns

self

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

Returns a copy with the given .carousel-item attributes.

Parameters

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

Returns

self