Class yii\bootstrap4\Carousel

All Classes | Properties | Methods

Inheritance	yii\bootstrap4\Carousel » yii\bootstrap4\Widget » yii\base\Widget
Uses Traits	yii\bootstrap4\BootstrapWidgetTrait

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' => [...],
        ],
    ]
]);

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$clientEvents	array	The event handlers for the underlying Bootstrap JS plugin.	yii\bootstrap4\BootstrapWidgetTrait
$clientOptions	array	The options for the underlying Bootstrap JS plugin.	yii\bootstrap4\BootstrapWidgetTrait
$controls	array\|false	The labels for the previous and the next control buttons.	yii\bootstrap4\Carousel
$crossfade	boolean	Animate slides with a fade transition instead of a slide.	yii\bootstrap4\Carousel
$items	array	List of slides in the carousel.	yii\bootstrap4\Carousel
$options	array	The HTML attributes for the widget container tag.	yii\bootstrap4\Carousel
$showIndicators	boolean	Whether carousel indicators ( tag with anchors to items) should be displayed or not.	yii\bootstrap4\Carousel

Public Methods

Hide inherited methods

Method	Description	Defined By
getView()		yii\bootstrap4\BootstrapWidgetTrait
init()	Initializes the widget.	yii\bootstrap4\Carousel
renderControls()	Renders previous and next control buttons.	yii\bootstrap4\Carousel
renderIndicators()	Renders carousel indicators.	yii\bootstrap4\Carousel
renderItem()	Renders a single carousel item	yii\bootstrap4\Carousel
renderItems()	Renders carousel items as specified on $items.	yii\bootstrap4\Carousel
run()		yii\bootstrap4\Carousel

Protected Methods

Hide inherited methods

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

Property Details

$controls public property

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

public array|false $controls = ['Previous', 'Next']

$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-ride' => 'carousel']

$showIndicators public property

Whether carousel indicators (

public boolean $showIndicators = true

Method Details

init() public method

Initializes the widget.

public void init ( )

renderControls() public method

Renders previous and next control buttons.

public void renderControls ( )
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, $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

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

public void run ( )
throws	\yii\base\InvalidConfigException