# Carousel

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

[API reference](/docs/api/index.md) › [Bootstrap 6](/docs/extensions/bootstrap6/reference/index.md) › Carousel

| class | `yii2\extensions\bootstrap6\Carousel` |
| --- | --- |
| Extends | [`Widget`](/docs/extensions/bootstrap6/reference/widget/index.md) » [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) » [`yii\base\Component`](/docs/api/yii/base/component/index.md) » [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| Implements | [`yii\base\ViewContextInterface`](/docs/api/yii/base/viewcontextinterface/index.md), [`yii\base\Configurable`](/docs/api/yii/base/configurable/index.md) |
| Uses traits | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md), [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| Source | [`src/Carousel.php`](https://github.com/yii2-extensions/bootstrap6/blob/main/src/Carousel.php#L26) |

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.

See also: <https://getbootstrap.com/docs/6.0/components/carousel/>.

## Properties

| Property | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="property-autoIdPrefix"></span>[`$autoIdPrefix`](/docs/api/yii/base/widget/index.md#property-autoIdPrefix) static | `string` | The prefix to the automatically generated widget IDs. Default: `'w'`. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="property-autoplay"></span>`$autoplay` | `bool` | Whether to cycle the slides automatically on page load (`data-bs-autoplay="true"`). Default: `false`. | `Carousel` |
| <span id="property-behaviors"></span>[`$behaviors`](/docs/api/yii/base/component/index.md#property-behaviors) read-only | `array<`[`yii\base\Behavior`](/docs/api/yii/base/behavior/index.md)`<static>>` | List of behaviors attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="property-clientEvents"></span>[`$clientEvents`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#property-clientEvents) | `array<string,` [`yii\web\JsExpression`](/docs/api/yii/web/jsexpression/index.md)`\|string>` | Event handlers attached to the widget element, as event name => JavaScript handler source. Default: `[]`. | [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| <span id="property-clientOptions"></span>[`$clientOptions`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#property-clientOptions) | `array<string, mixed>\|false` | Options passed to the plugin constructor, or `false` to skip the JavaScript initialization. Default: `[]`. | [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| [`$controls`](#property-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` |
| <span id="property-controlsOptions"></span>`$controlsOptions` | `array<string, mixed>` | HTML attributes of the element wrapping the controls and the indicators. Default: `[]`. | `Carousel` |
| <span id="property-crossfade"></span>`$crossfade` | `bool` | Whether to fade between slides instead of sliding (`.carousel-fade`). Default: `false`. | `Carousel` |
| <span id="property-ends"></span>`$ends` | [`yii2\extensions\bootstrap6\enum\CarouselEnds`](/docs/extensions/bootstrap6/reference/enum/carouselends/index.md)`\|string\|null` | Behavior at the first and last slides (`data-bs-ends`), or `null` for the default `loop`. Default: `null`. | `Carousel` |
| <span id="property-id"></span>[`$id`](/docs/api/yii/base/widget/index.md#property-id) | `string` | Id of the widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="property-indicatorLabel"></span>`$indicatorLabel` | `string\|`[`Stringable`](https://www.php.net/manual/en/class.stringable.php) | Accessible label of each indicator; `{number}` is replaced with the slide number starting at `1`. Default: `'Slide {number}'`. | `Carousel` |
| <span id="property-interval"></span>`$interval` | `int\|null` | Delay in milliseconds between slides when cycling (`data-bs-interval`), or `null` for the default. Default: `null`. | `Carousel` |
| [`$items`](#property-items) | `array<array-key, array<string, mixed>\|`[`yii2\extensions\bootstrap6\item\CarouselItem`](/docs/extensions/bootstrap6/reference/item/carouselitem/index.md)`\|string\|`[`Stringable`](https://www.php.net/manual/en/class.stringable.php)`>` | Carousel slides: [`CarouselItem`](/docs/extensions/bootstrap6/reference/item/carouselitem/index.md) instances, arrays converted through [`CarouselItem::fromArray()`](/docs/extensions/bootstrap6/reference/item/carouselitem/index.md#method-fromArray), or the slide content (not encoded). Default: `[]`. | `Carousel` |
| <span id="property-keyboard"></span>`$keyboard` | `bool\|null` | Whether the carousel reacts to keyboard events (`data-bs-keyboard`), or `null` for the default. Default: `null`. | `Carousel` |
| <span id="property-options"></span>[`$options`](/docs/extensions/bootstrap6/reference/widget/index.md#property-options) | `array<string, mixed>` | HTML attributes of the widget container tag. Default: `[]`. | [`Widget`](/docs/extensions/bootstrap6/reference/widget/index.md) |
| <span id="property-overlay"></span>`$overlay` | `bool` | Whether to overlay the controls on the slides (`.carousel-overlay`). Default: `false`. | `Carousel` |
| <span id="property-pause"></span>`$pause` | `string\|false\|null` | Pause behavior on hover (`data-bs-pause`): `hover`, `false` to never pause, or `null` for the default. Default: `null`. | `Carousel` |
| <span id="property-playPause"></span>`$playPause` | `bool` | Whether to render the play/pause control (`.carousel-control-play-pause`). Default: `false`. | `Carousel` |
| <span id="property-showIndicators"></span>`$showIndicators` | `bool` | Whether to render the slide indicators. Default: `true`. | `Carousel` |
| <span id="property-view"></span>[`$view`](/docs/api/yii/base/widget/index.md#property-view) | [`yii\web\View`](/docs/api/yii/web/view/index.md) | The view object that can be used to render views or view files. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="property-viewPath"></span>[`$viewPath`](/docs/api/yii/base/widget/index.md#property-viewPath) read-only | `string` | The directory containing the view files for this widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| <span id="method-__construct"></span>[`__construct()`](/docs/api/yii/base/baseobject/index.md#method-__construct) | Constructor. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-__call"></span>[`__call()`](/docs/api/yii/base/component/index.md#method-__call) | Calls the named method which is not a class method. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__clone"></span>[`__clone()`](/docs/api/yii/base/component/index.md#method-__clone) | This method is called after the object is created by cloning an existing one. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__get"></span>[`__get()`](/docs/api/yii/base/component/index.md#method-__get) | Returns the value of a component property. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__isset"></span>[`__isset()`](/docs/api/yii/base/component/index.md#method-__isset) | Checks if a property is set, i.e. defined and not null. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__set"></span>[`__set()`](/docs/api/yii/base/component/index.md#method-__set) | Sets the value of a component property. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__unset"></span>[`__unset()`](/docs/api/yii/base/component/index.md#method-__unset) | Sets a component property to be null. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-addAttributes"></span>[`addAttributes()`](/docs/extensions/bootstrap6/reference/attributestrait/index.md#method-addAttributes) | Adds a set of HTML attributes; attributes already set with the same name are replaced. | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md) |
| <span id="method-addClass"></span>[`addClass()`](/docs/extensions/bootstrap6/reference/attributestrait/index.md#method-addClass) | Adds one or more CSS classes to the existing classes; duplicated classes are collapsed. | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md) |
| <span id="method-addCssStyle"></span>[`addCssStyle()`](/docs/extensions/bootstrap6/reference/attributestrait/index.md#method-addCssStyle) | Adds CSS style properties to the `style` attribute. | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md) |
| <span id="method-afterRun"></span>[`afterRun()`](/docs/api/yii/base/widget/index.md#method-afterRun) | This method is invoked right after a widget is executed. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-attachBehavior"></span>[`attachBehavior()`](/docs/api/yii/base/component/index.md#method-attachBehavior) | Attaches a behavior to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-attachBehaviors"></span>[`attachBehaviors()`](/docs/api/yii/base/component/index.md#method-attachBehaviors) | Attaches a list of behaviors to the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-attribute"></span>[`attribute()`](/docs/extensions/bootstrap6/reference/attributestrait/index.md#method-attribute) | Sets an HTML attribute value. | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md) |
| <span id="method-beforeRun"></span>[`beforeRun()`](/docs/api/yii/base/widget/index.md#method-beforeRun) | This method is invoked right before the widget is executed. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-begin"></span>[`begin()`](/docs/api/yii/base/widget/index.md#method-begin) static | Begins a widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-behaviors"></span>[`behaviors()`](/docs/api/yii/base/component/index.md#method-behaviors) | Returns a list of behaviors that this component should behave as. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-canGetProperty"></span>[`canGetProperty()`](/docs/api/yii/base/component/index.md#method-canGetProperty) | Returns a value indicating whether a property can be read. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-canSetProperty"></span>[`canSetProperty()`](/docs/api/yii/base/component/index.md#method-canSetProperty) | Returns a value indicating whether a property can be set. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-class"></span>[`class()`](/docs/extensions/bootstrap6/reference/attributestrait/index.md#method-class) | Replaces the existing CSS classes with the specified ones. | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md) |
| <span id="method-className"></span>[`className()`](/docs/api/yii/base/baseobject/index.md#method-className) static | Returns the fully qualified name of this class. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-detachBehavior"></span>[`detachBehavior()`](/docs/api/yii/base/component/index.md#method-detachBehavior) | Detaches a behavior from the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-detachBehaviors"></span>[`detachBehaviors()`](/docs/api/yii/base/component/index.md#method-detachBehaviors) | Detaches all behaviors from the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-end"></span>[`end()`](/docs/api/yii/base/widget/index.md#method-end) static | Ends a widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-ensureBehaviors"></span>[`ensureBehaviors()`](/docs/api/yii/base/component/index.md#method-ensureBehaviors) | Makes sure that the behaviors declared in [`behaviors()`](/docs/api/yii/base/component/index.md#method-behaviors) are attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-getBehavior"></span>[`getBehavior()`](/docs/api/yii/base/component/index.md#method-getBehavior) | Returns the named behavior object. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-getBehaviors"></span>[`getBehaviors()`](/docs/api/yii/base/component/index.md#method-getBehaviors) | Returns all behaviors attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-getId"></span>[`getId()`](/docs/api/yii/base/widget/index.md#method-getId) | Returns the ID of the widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-getView"></span>[`getView()`](/docs/api/yii/base/widget/index.md#method-getView) | Returns the view object that can be used to render views or view files. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-getViewPath"></span>[`getViewPath()`](/docs/api/yii/base/widget/index.md#method-getViewPath) | Returns the directory containing the view files for this widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-hasEventHandlers"></span>[`hasEventHandlers()`](/docs/api/yii/base/component/index.md#method-hasEventHandlers) | Returns a value indicating whether there is any handler attached to the named event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-hasMethod"></span>[`hasMethod()`](/docs/api/yii/base/component/index.md#method-hasMethod) | Returns a value indicating whether a method is defined. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-hasProperty"></span>[`hasProperty()`](/docs/api/yii/base/component/index.md#method-hasProperty) | Returns a value indicating whether a property is defined for this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| [`init()`](#method-init) | Initializes the widget and validates [`$ends`](/docs/extensions/bootstrap6/reference/carousel/index.md#property-ends). | `Carousel` |
| <span id="method-off"></span>[`off()`](/docs/api/yii/base/component/index.md#method-off) | Detaches an existing event handler from this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-on"></span>[`on()`](/docs/api/yii/base/component/index.md#method-on) | Attaches an event handler to an event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-render"></span>[`render()`](/docs/api/yii/base/widget/index.md#method-render) | Renders a view. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-renderFile"></span>[`renderFile()`](/docs/api/yii/base/widget/index.md#method-renderFile) | Renders a view file. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| [`run()`](#method-run) |  | `Carousel` |
| <span id="method-setId"></span>[`setId()`](/docs/api/yii/base/widget/index.md#method-setId) | Sets the ID of the widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-setView"></span>[`setView()`](/docs/api/yii/base/widget/index.md#method-setView) | Sets the view object to be used by this widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-trigger"></span>[`trigger()`](/docs/api/yii/base/component/index.md#method-trigger) | Triggers an event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-widget"></span>[`widget()`](/docs/api/yii/base/widget/index.md#method-widget) static | Creates a widget instance and runs it. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| [`carouselOptions()`](#method-carouselOptions) protected | Returns the HTML attributes of the `.carousel` element. | `Carousel` |
| <span id="method-pluginInitialization"></span>[`pluginInitialization()`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#method-pluginInitialization) protected | Returns the JavaScript that initializes a plugin with its normalized constructor options. | [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| <span id="method-registerClientEvents"></span>[`registerClientEvents()`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#method-registerClientEvents) protected | Registers the JavaScript event handlers listed in [`$clientEvents`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#property-clientEvents) at [`View::POS_END`](/docs/api/yii/web/view/index.md#const-POS_END). | [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| <span id="method-registerPlugin"></span>[`registerPlugin()`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#method-registerPlugin) protected | Registers the plugin asset, the plugin initialization when needed, and the [`$clientEvents`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#property-clientEvents). | [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| [`renderControls()`](#method-renderControls) protected | Renders the previous/next and play/pause controls with the indicators, or an empty string when all are disabled. | `Carousel` |
| [`renderIndicators()`](#method-renderIndicators) protected | Renders the `.carousel-indicators` element. | `Carousel` |
| [`renderItem()`](#method-renderItem) protected | Renders a single `.carousel-item` element. | `Carousel` |
| [`renderItems()`](#method-renderItems) protected | Renders the `.carousel-inner` element with every slide. | `Carousel` |

## Events

| Event | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="event-EVENT_INIT"></span>[`EVENT_INIT`](/docs/api/yii/base/widget/index.md#event-EVENT_INIT) | [`yii\base\Event`](/docs/api/yii/base/event/index.md) | An event that is triggered when the widget is initialized via [`init()`](/docs/api/yii/base/widget/index.md#method-init). Event name: `'init'`. Available since 2.0.11. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="event-EVENT_BEFORE_RUN"></span>[`EVENT_BEFORE_RUN`](/docs/api/yii/base/widget/index.md#event-EVENT_BEFORE_RUN) | [`yii\base\WidgetEvent`](/docs/api/yii/base/widgetevent/index.md) | An event raised right before executing a widget. Event name: `'beforeRun'`. Available since 2.0.11. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="event-EVENT_AFTER_RUN"></span>[`EVENT_AFTER_RUN`](/docs/api/yii/base/widget/index.md#event-EVENT_AFTER_RUN) | [`yii\base\WidgetEvent`](/docs/api/yii/base/widgetevent/index.md) | An event raised right after executing a widget. Event name: `'afterRun'`. Available since 2.0.11. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |

## Property details

### $controls <span id="property-controls"></span>

```php
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 <span id="property-items"></span>

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

Carousel slides: [`CarouselItem`](/docs/extensions/bootstrap6/reference/item/carouselitem/index.md) instances, arrays converted through [`CarouselItem::fromArray()`](/docs/extensions/bootstrap6/reference/item/carouselitem/index.md#method-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() <span id="method-init"></span>

```php
public function init(): void
```

Initializes the widget and validates [`$ends`](/docs/extensions/bootstrap6/reference/carousel/index.md#property-ends).

**Throws**

- [`yii\base\InvalidConfigException`](/docs/api/yii/base/invalidconfigexception/index.md): if [`$ends`](/docs/extensions/bootstrap6/reference/carousel/index.md#property-ends) is not a [`CarouselEnds`](/docs/extensions/bootstrap6/reference/enum/carouselends/index.md) value.

### run() <span id="method-run"></span>

```php
public function run(): string
```

**Returns**

`string`

**Throws**

- [`yii\base\InvalidConfigException`](/docs/api/yii/base/invalidconfigexception/index.md): if [`$items`](/docs/extensions/bootstrap6/reference/carousel/index.md#property-items) is empty or an item lacks its `content` option.

### carouselOptions() <span id="method-carouselOptions"></span>

```php
protected function carouselOptions(): mixed[]
```

Returns the HTML attributes of the `.carousel` element.

**Returns**

`mixed[]`

### renderControls() <span id="method-renderControls"></span>

```php
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() <span id="method-renderIndicators"></span>

```php
protected function renderIndicators(): string
```

Renders the `.carousel-indicators` element.

**Returns**

`string`

### renderItem() <span id="method-renderItem"></span>

```php
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`](/docs/extensions/bootstrap6/reference/item/carouselitem/index.md) |  |
| `$index` | `int` | Zero-based position of the item. |

**Returns**

`string`

### renderItems() <span id="method-renderItems"></span>

```php
protected function renderItems(): string
```

Renders the `.carousel-inner` element with every slide.

**Returns**

`string`

**Throws**

- [`yii\base\InvalidConfigException`](/docs/api/yii/base/invalidconfigexception/index.md): if an item lacks its `content` option.