Class yii\bootstrap5\Carousel

All Classes | Properties | Methods | Events
Inheritanceyii\bootstrap5\Carousel » yii\bootstrap5\Widget » yii\base\Widget » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable, yii\base\ViewContextInterface
Uses Traitsyii\bootstrap5\BootstrapWidgetTrait
Source Code https://github.com/yiisoft/yii2/blob/master/framework/bootstrap5/Carousel.php

Carousel renders a carousel bootstrap javascript component.

For example:

echo Carousel::widget([
    'items' => [
        // the item contains only the image
        '<img src="http://twitter.github.io/bootstrap/assets/img/bootstrap-mdo-sfmoma-01.jpg"/>',
        // equivalent to the above
        ['content' => '<img src="http://twitter.github.io/bootstrap/assets/img/bootstrap-mdo-sfmoma-02.jpg"/>'],
        // the item contains both the image and the caption
        [
            'content' => '<img src="http://twitter.github.io/bootstrap/assets/img/bootstrap-mdo-sfmoma-03.jpg"/>',
            'caption' => '<h4>This is title</h4><p>This is the caption text</p>',
            'captionOptions' => ['class' => ['d-none', 'd-md-block']]
            'options' => [...],
        ],
    ]
]);

See also https://getbootstrap.com/docs/5.1/components/carousel/.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$autoIdPrefix string The prefix to the automatically generated widget IDs. yii\base\Widget
$behaviors yii\base\Behavior[] List of behaviors attached to this component. yii\base\Component
$clientEvents array The event handlers for the underlying Bootstrap JS plugin. yii\bootstrap5\BootstrapWidgetTrait
$clientOptions array|boolean The options for the underlying Bootstrap JS plugin. yii\bootstrap5\BootstrapWidgetTrait
$controls array|null The labels for the previous and the next control buttons. yii\bootstrap5\Carousel
$counter integer A counter used to generate $id for widgets. yii\base\Widget
$crossfade boolean Animate slides with a fade transition instead of a slide. yii\bootstrap5\Carousel
$id string|null ID of the widget. Note that the type of this property differs in getter and setter. See getId() and setId() for details. yii\base\Widget
$items array List of slides in the carousel. yii\bootstrap5\Carousel
$options array The HTML attributes for the widget container tag. yii\bootstrap5\Carousel
$showIndicators boolean Whether carousel indicators (
    tag with anchors to items) should be displayed or not.
 yii\bootstrap5\Carousel
$stack yii\base\Widget[] The widgets that are currently being rendered (not ended). yii\base\Widget
$view yii\web\View The view object that can be used to render views or view files. Note that the type of this property differs in getter and setter. See getView() and setView() for details. yii\base\Widget
$viewPath string The directory containing the view files for this widget. yii\base\Widget

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__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
__construct() Constructor. yii\base\BaseObject
__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
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
beforeRun() This method is invoked right before the widget is executed. yii\base\Widget
begin() 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
className() 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() 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() {@inheritDoc} yii\bootstrap5\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
renderControls() Renders previous and next control buttons. yii\bootstrap5\Carousel
renderFile() Renders a view file. yii\base\Widget
renderIndicators() Renders carousel indicators. yii\bootstrap5\Carousel
renderItem() Renders a single carousel item yii\bootstrap5\Carousel
renderItems() Renders carousel items as specified on $items. yii\bootstrap5\Carousel
run() Executes the widget. yii\bootstrap5\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() Creates a widget instance and runs it. yii\base\Widget

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
registerClientEvents() Registers JS event handlers that are listed in $clientEvents. yii\bootstrap5\BootstrapWidgetTrait
registerPlugin() Registers a specific Bootstrap plugin and the related events yii\bootstrap5\BootstrapWidgetTrait

Events

Hide inherited events

EventTypeDescriptionDefined By
EVENT_AFTER_RUN yii\base\WidgetEvent An event raised right after executing a widget. (available since version 2.0.11) yii\base\Widget
EVENT_BEFORE_RUN yii\base\WidgetEvent An event raised right before executing a widget. (available since version 2.0.11) yii\base\Widget
EVENT_INIT yii\base\Event An event that is triggered when the widget is initialized via init(). (available since version 2.0.11) yii\base\Widget

Property Details

$controls public property

The labels for the previous and the next control buttons. If null, it means the previous and the next control buttons should not be displayed.

public array|null $controls = [
    '<span class="carousel-control-prev-icon" aria-hidden="true"></span><span class="visually-hidden">Previous</span>', '<span class="carousel-control-next-icon" aria-hidden="true"></span><span class="visually-hidden">Next</span>'
]
$crossfade public property

Animate slides with a fade transition instead of a slide. Defaults to false

public boolean $crossfade = false
$items public property

List of slides in the carousel. Each array element represents a single slide with the following structure:

[
    // required, slide content (HTML), such as an image tag
    'content' => '<img src="http://twitter.github.io/bootstrap/assets/img/bootstrap-mdo-sfmoma-01.jpg"/>',
    // optional, the caption (HTML) of the slide
    'caption' => '<h4>This is title</h4><p>This is the caption text</p>',
    // optional the HTML attributes of the slide container
    'options' => [],
]
public array $items = []
$options public property

The HTML attributes for the widget container tag.

public array $options = [
    'data' => ['bs-ride' => 'carousel']
]
$showIndicators public property

Whether carousel indicators (

    tag with anchors to items) should be displayed or not.

public boolean $showIndicators = true

Method Details

init() public method

{@inheritDoc}

public void init ( )
throws yii\base\InvalidConfigException
renderControls() public method

Renders previous and next control buttons.

public string renderControls ( )
return string

The rendered controls
throws yii\base\InvalidConfigException

if $controls is invalid.
renderIndicators() public method

Renders carousel indicators.

public string renderIndicators ( )
return string

The rendering result
renderItem() public method

Renders a single carousel item

public string renderItem ( $item, \yii\bootstrap5\int $index )
$item string|array

A single item from $items
$index integer

The item index as the first item should be set to active
return string

The rendering result
throws yii\base\InvalidConfigException

if the item is invalid
throws Exception
renderItems() public method

Renders carousel items as specified on $items.

public string renderItems ( )
return string

The rendering result
throws yii\base\InvalidConfigException
run() public method

Executes the widget.

public string|void run ( )
return string|void

The rendering result may be directly "echoed" or returned as a string
throws yii\base\InvalidConfigException