Carousel

API reference › Bootstrap 6 › Carousel

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

Renders a Bootstrap carousel with optional previous/next controls, play/pause control, and indicators.

The plugin is always initialized so that the indicators follow the visible slide.

Properties

Property	Type	Description	Defined by
`$autoIdPrefix` static	`string`	The prefix to the automatically generated widget IDs. Default: `'w'`.	`yii\base\Widget`
`$autoplay`	`bool`	Whether to cycle the slides automatically on page load (`data-bs-autoplay="true"`). Default: `false`.	`Carousel`
`$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`
`$controls`	`array<int, string>\|false`	Visually hidden labels of the previous and next controls, as `[previous, next]`, or `false` to omit the controls. Default: `[]`.	`Carousel`
`$controlsOptions`	`array<string, mixed>`	HTML attributes of the element wrapping the controls and the indicators. Default: `[]`.	`Carousel`
`$crossfade`	`bool`	Whether to fade between slides instead of sliding (`.carousel-fade`). Default: `false`.	`Carousel`
`$ends`	`yii2\extensions\bootstrap6\enum\CarouselEnds\|string\|null`	Behavior at the first and last slides (`data-bs-ends`), or `null` for the default `loop`. Default: `null`.	`Carousel`
`$id`	`string`	Id of the widget.	`yii\base\Widget`
`$indicatorLabel`	`string\|Stringable`	Accessible label of each indicator; `{number}` is replaced with the slide number starting at `1`. Default: `'Slide {number}'`.	`Carousel`
`$interval`	`int\|null`	Delay in milliseconds between slides when cycling (`data-bs-interval`), or `null` for the default. Default: `null`.	`Carousel`
`$items`	`array<array-key, array<string, mixed>\|yii2\extensions\bootstrap6\item\CarouselItem\|string\|Stringable>`	Carousel slides: `CarouselItem` instances, arrays converted through `CarouselItem::fromArray()`, or the slide content (not encoded). Default: `[]`.	`Carousel`
`$keyboard`	`bool\|null`	Whether the carousel reacts to keyboard events (`data-bs-keyboard`), or `null` for the default. Default: `null`.	`Carousel`
`$options`	`array<string, mixed>`	HTML attributes of the widget container tag. Default: `[]`.	`Widget`
`$overlay`	`bool`	Whether to overlay the controls on the slides (`.carousel-overlay`). Default: `false`.	`Carousel`
`$pause`	`string\|false\|null`	Pause behavior on hover (`data-bs-pause`): `hover`, `false` to never pause, or `null` for the default. Default: `null`.	`Carousel`
`$playPause`	`bool`	Whether to render the play/pause control (`.carousel-control-play-pause`). Default: `false`.	`Carousel`
`$showIndicators`	`bool`	Whether to render the slide indicators. Default: `true`.	`Carousel`
`$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 `$ends`.	`Carousel`
`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()`		`Carousel`
`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`
`carouselOptions()` protected	Returns the HTML attributes of the `.carousel` element.	`Carousel`
`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`
`renderControls()` protected	Renders the previous/next and play/pause controls with the indicators, or an empty string when all are disabled.	`Carousel`
`renderIndicators()` protected	Renders the `.carousel-indicators` element.	`Carousel`
`renderItem()` protected	Renders a single `.carousel-item` element.	`Carousel`
`renderItems()` protected	Renders the `.carousel-inner` element with every slide.	`Carousel`

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

$controls

public array<int, string>|false $controls = []

Visually hidden labels of the previous and next controls, as [previous, next], or false to omit the controls.

Missing labels default to the translated Previous and Next.

$items

public array<array-key, array<string, mixed>|yii2\extensions\bootstrap6\item\CarouselItem|string|Stringable> $items = []

Carousel slides: CarouselItem instances, arrays converted through CarouselItem::fromArray(), or the slide content (not encoded).

An array item accepts the following options:

content: string|Stringable, required, slide content (not encoded).
options: array, HTML attributes of the .carousel-item element.

The first slide is the active one.

Method details

init()

public function init(): void

Initializes the widget and validates $ends.

Throws

yii\base\InvalidConfigException: if $ends is not a CarouselEnds value.

run()

public function run(): string

Returns

string

Throws

yii\base\InvalidConfigException: if $items is empty or an item lacks its content option.

carouselOptions()

protected function carouselOptions(): mixed[]

Returns the HTML attributes of the .carousel element.

Returns

mixed[]

renderControls()

protected function renderControls(): string

Renders the previous/next and play/pause controls with the indicators, or an empty string when all are disabled.

Returns

string

renderIndicators()

protected function renderIndicators(): string

Renders the .carousel-indicators element.

Returns

string

renderItem()

protected function renderItem(yii2\extensions\bootstrap6\item\CarouselItem $item, int $index): string

Renders a single .carousel-item element.

Parameters

Parameter	Type	Description
`$item`	`yii2\extensions\bootstrap6\item\CarouselItem`
`$index`	`int`	Zero-based position of the item.

Returns

string

renderItems()

protected function renderItems(): string

Renders the .carousel-inner element with every slide.

Returns

string

Throws

yii\base\InvalidConfigException: if an item lacks its content option.