Inheritance | yii\bootstrap\Collapse » yii\bootstrap\Widget » yii\base\Widget » yii\base\Component » yii\base\Object |
---|---|
Implements | yii\base\Configurable, yii\base\ViewContextInterface |
Uses Traits | yii\bootstrap\BootstrapWidgetTrait |
Available since version | 2.0 |
Source Code | https://github.com/yiisoft/yii2-bootstrap/blob/master/Collapse.php |
Collapse renders an accordion bootstrap javascript component.
For example:
echo Collapse::widget([ 'items' => [ // equivalent to the above [ 'label' => 'Collapsible Group Item #1', 'content' => 'Anim pariatur cliche...', // open its content by default 'contentOptions' => ['class' => 'in'] ], // another group item [ 'label' => 'Collapsible Group Item #1', 'content' => 'Anim pariatur cliche...', 'contentOptions' => [...], 'options' => [...], ], // if you want to swap out .panel-body with .list-group, you may use the following [ 'label' => 'Collapsible Group Item #1', 'content' => [ 'Anim pariatur cliche...', 'Anim pariatur cliche...' ], 'contentOptions' => [...], 'options' => [...], 'footer' => 'Footer' // the footer label in list-group ], ] ]);
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\BootstrapWidgetTrait |
$clientOptions | array | The options for the underlying Bootstrap JS plugin. | yii\bootstrap\BootstrapWidgetTrait |
$counter | integer | A counter used to generate $id for widgets. | yii\base\Widget |
$encodeLabels | boolean | Whether the labels for header items should be HTML-encoded. | yii\bootstrap\Collapse |
$id | string | ID of the widget. | yii\base\Widget |
$items | array | List of groups in the collapse widget. | yii\bootstrap\Collapse |
$options | array | The HTML attributes for the widget container tag. | yii\bootstrap\Widget |
$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\bootstrap\BootstrapWidgetTrait |
$viewPath | string | The directory containing the view files for this widget. | yii\base\Widget |
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 |
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\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() | yii\bootstrap\BootstrapWidgetTrait | |
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\Collapse |
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 |
renderItem() | Renders a single collapsible item group | yii\bootstrap\Collapse |
renderItems() | Renders collapsible items as specified on $items. | yii\bootstrap\Collapse |
run() | Renders the widget. | yii\bootstrap\Collapse |
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 |
Method | Description | Defined By |
---|---|---|
registerClientEvents() | Registers JS event handlers that are listed in $clientEvents. | yii\bootstrap\BootstrapWidgetTrait |
registerPlugin() | Registers a specific Bootstrap plugin and the related events | yii\bootstrap\BootstrapWidgetTrait |
Event | Type | Description | Defined 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 |
Whether the labels for header items should be HTML-encoded.
public boolean $encodeLabels = true
List of groups in the collapse widget. Each array element represents a single group with the following structure:
$this->encodeLabels
param.public array $items = []
Initializes the widget.
public void init ( ) |
---|
Renders a single collapsible item group
public string renderItem ( $header, $item, $index ) | ||
---|---|---|
$header | string |
A label of the item group $items |
$item | array |
A single item from $items |
$index | integer |
The item index as each item group content must have an id |
return | string |
The rendering result |
throws | yii\base\InvalidConfigException |
Renders collapsible items as specified on $items.
public string renderItems ( ) | ||
---|---|---|
return | string |
The rendering result |
throws | yii\base\InvalidConfigException |
if label isn't specified |
Renders the widget.
public void run ( ) |
---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-bootstrap-collapse.html