Class yii\bootstrap\Carousel
| Inheritance | yii\bootstrap\Carousel » yii\bootstrap\Widget » yii\base\Widget » yii\base\Component » yii\base\Object |
|---|---|
| Implements | yii\base\Configurable, yii\base\ViewContextInterface |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-bootstrap/blob/master/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>',
'options' => [...],
],
]
]);Public Properties
| Property | Type | Description | Defined 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\bootstrap\Widget |
| $clientOptions | array | The options for the underlying Bootstrap JS plugin. | yii\bootstrap\Widget |
| $controls | array|boolean | The labels for the previous and the next control buttons. | yii\bootstrap\Carousel |
| $counter | integer | A counter used to generate $id for widgets. | yii\base\Widget |
| $id | string | ID of the widget. | yii\base\Widget |
| $items | array | List of slides in the carousel. | yii\bootstrap\Carousel |
| $options | array | The HTML attributes for the widget container tag. | yii\bootstrap\Widget |
| $showIndicators | boolean | If false carousel indicators (
|
yii\bootstrap\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. | yii\base\Widget |
| $viewPath | string | The directory containing the view files for this widget. | yii\base\Widget |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Object |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\Object |
| __get() | Returns the value of an object property. | yii\base\Object |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Object |
| __set() | Sets value of an object property. | yii\base\Object |
| __unset() | Sets an object property to null. | yii\base\Object |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| 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\Object |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Object |
| className() | Returns the fully qualified name of this class. | yii\base\Object |
| 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\Object |
| hasProperty() | Returns a value indicating whether a property is defined. | yii\base\Object |
| init() | Initializes the widget. | yii\bootstrap\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\bootstrap\Carousel |
| renderFile() | Renders a view file. | yii\base\Widget |
| renderIndicators() | Renders carousel indicators. | yii\bootstrap\Carousel |
| renderItem() | Renders a single carousel item | yii\bootstrap\Carousel |
| renderItems() | Renders carousel items as specified on $items. | yii\bootstrap\Carousel |
| run() | Renders the widget. | yii\bootstrap\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
| Method | Description | Defined By |
|---|---|---|
| registerClientEvents() | Registers JS event handlers that are listed in $clientEvents. | yii\bootstrap\Widget |
| registerPlugin() | Registers a specific Bootstrap plugin and the related events | yii\bootstrap\Widget |
Property Details
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.
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' => [],
]If false carousel indicators (
- tag with anchors to items) should not be displayed.
Method Details
Initializes the widget.
| void init( ) |
Renders previous and next control buttons.
| void renderControls( ) | ||
| throws | yii\base\InvalidConfigException | if $controls is invalid. |
|---|---|---|
Renders carousel indicators.
| string renderIndicators( ) | ||
| return | string | The rendering result |
|---|---|---|
Renders a single carousel item
| 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 |
| return | string | The rendering result |
|---|---|---|
| throws | yii\base\InvalidConfigException | if the item is invalid |
Renders carousel items as specified on $items.
| string renderItems( ) | ||
| return | string | The rendering result |
|---|---|---|
Renders the widget.
| void run( ) |