Class yii\bootstrap\Collapse

All Classes | Properties | Methods
Inheritanceyii\bootstrap\Collapse » yii\bootstrap\Widget » yii\base\Widget
Uses Traitsyii\bootstrap\BootstrapWidgetTrait
Available since extension's version2.0
Source Code https://github.com/yiisoft/yii2-bootstrap/blob/master/src/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
        ],
    ]
]);

See also http://getbootstrap.com/javascript/#collapse.

Public Properties

Hide inherited properties

Property Type Description Defined By
$autoCloseItems boolean Whether to close other items if an item is opened. yii\bootstrap\Collapse
$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
$encodeLabels boolean Whether the labels for header items should be HTML-encoded. yii\bootstrap\Collapse
$itemToggleOptions array The HTML options for the item toggle tag. yii\bootstrap\Collapse
$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

Public Methods

Hide inherited methods

Method Description Defined By
getView() yii\bootstrap\BootstrapWidgetTrait
init() Initializes the widget. yii\bootstrap\Collapse
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

Protected Methods

Hide inherited methods

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

Property Details

Hide inherited properties

$autoCloseItems public property (available since version 2.0.7)

Whether to close other items if an item is opened. Defaults to true which causes an accordion effect. Set this to false to allow keeping multiple items open at once.

public boolean $autoCloseItems = true
$encodeLabels public property

Whether the labels for header items should be HTML-encoded.

public boolean $encodeLabels = true
$itemToggleOptions public property (available since version 2.0.8)

The HTML options for the item toggle tag. Key 'tag' might be used here for the tag name specification. For example:

[
    'tag' => 'div',
    'class' => 'custom-toggle',
]
public array $itemToggleOptions = []
$items public property

List of groups in the collapse widget. Each array element represents a single group with the following structure:

  • label: string, required, the group header label.
  • encode: bool, optional, whether this label should be HTML-encoded. This param will override global $this->encodeLabels param.
  • content: array|string|object, required, the content (HTML) of the group
  • options: array, optional, the HTML attributes of the group
  • contentOptions: optional, the HTML attributes of the group's content

Since version 2.0.7 you may also specify this property as key-value pairs, where the key refers to the label and the value refers to content. If value is a string it is interpreted as label. If it is an array, it is interpreted as explained above.

For example:

echo Collapse::widget([
    'items' => [
      'Introduction' => 'This is the first collapsable menu',
      'Second panel' => [
          'content' => 'This is the second collapsable menu',
      ],
      [
          'label' => 'Third panel',
          'content' => 'This is the third collapsable menu',
      ],
  ]
])
public array $items = []

Method Details

Hide inherited methods

getView() public abstract method

Defined in: yii\bootstrap\BootstrapWidgetTrait::getView()

See also \yii\base\Widget::getView().

public abstract \yii\web\View getView ( )
return \yii\web\View

The view object that can be used to render views or view files.

 

                abstract function getView();
init() public method

Initializes the widget.

public void init ( )

                public function init()
{
    parent::init();
    Html::addCssClass($this->options, ['widget' => 'panel-group']);
}
registerClientEvents() protected method (available since version 2.0.2)

Defined in: yii\bootstrap\BootstrapWidgetTrait::registerClientEvents()

Registers JS event handlers that are listed in $clientEvents.

protected void registerClientEvents ( )

                protected function registerClientEvents()
{
    if (!empty($this->clientEvents)) {
        $id = $this->options['id'];
        $js = [];
        foreach ($this->clientEvents as $event => $handler) {
            $js[] = "jQuery('#$id').on('$event', $handler);";
        }
        $this->getView()->registerJs(implode("\n", $js));
    }
}
registerPlugin() protected method

Defined in: yii\bootstrap\BootstrapWidgetTrait::registerPlugin()

Registers a specific Bootstrap plugin and the related events

protected void registerPlugin ( $name )
$name string

The name of the Bootstrap plugin

 

                protected function registerPlugin($name)
{
    $view = $this->getView();
    BootstrapPluginAsset::register($view);
    $id = $this->options['id'];
    if ($this->clientOptions !== false) {
        $options = empty($this->clientOptions) ? '' : Json::htmlEncode($this->clientOptions);
        $js = "jQuery('#$id').$name($options);";
        $view->registerJs($js);
    }
    $this->registerClientEvents();
}
renderItem() public method

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 

                public function renderItem($header, $item, $index)
{
    if (array_key_exists('content', $item)) {
        $id = $this->options['id'] . '-collapse' . $index;
        $options = ArrayHelper::getValue($item, 'contentOptions', []);
        $options['id'] = $id;
        Html::addCssClass($options, ['widget' => 'panel-collapse', 'collapse' => 'collapse']);
        $encodeLabel = isset($item['encode']) ? $item['encode'] : $this->encodeLabels;
        if ($encodeLabel) {
            $header = Html::encode($header);
        }
        $active = false;
        if (isset($options['class'])) {
            $classes = is_string($options['class']) ? preg_split('/\s+/', $options['class'], -1, PREG_SPLIT_NO_EMPTY) : $options['class'];
            $active = in_array('in', $classes, true);
        }
        $itemToggleOptions = array_merge([
            'tag' => 'a',
            'data-toggle' => 'collapse',
        ], $this->itemToggleOptions);
        Html::addCssClass($itemToggleOptions, ['widget' => 'collapse-toggle']);
        if (!$active) {
            Html::addCssClass($itemToggleOptions, ['collapsed' => 'collapsed']);
        }
        if ($this->autoCloseItems) {
            $itemToggleOptions['data-parent'] = '#' . $this->options['id'];
        }
        $itemToggleTag = ArrayHelper::remove($itemToggleOptions, 'tag', 'a');
        if ($itemToggleTag === 'a') {
            $headerToggle = Html::a($header, '#' . $id, $itemToggleOptions) . "\n";
        } else {
            $itemToggleOptions['data-target'] = '#' . $id;
            $headerToggle = Html::tag($itemToggleTag, $header, $itemToggleOptions) . "\n";
        }
        $header = Html::tag('h4', $headerToggle, ['class' => 'panel-title']);
        if (is_string($item['content']) || is_numeric($item['content']) || is_object($item['content'])) {
            $content = Html::tag('div', $item['content'], ['class' => 'panel-body']) . "\n";
        } elseif (is_array($item['content'])) {
            $content = Html::ul($item['content'], [
                'class' => 'list-group',
                'itemOptions' => [
                    'class' => 'list-group-item'
                ],
                'encode' => false,
            ]) . "\n";
            if (isset($item['footer'])) {
                $content .= Html::tag('div', $item['footer'], ['class' => 'panel-footer']) . "\n";
            }
        } else {
            throw new InvalidConfigException('The "content" option should be a string, array or object.');
        }
    } else {
        throw new InvalidConfigException('The "content" option is required.');
    }
    $group = [];
    $group[] = Html::tag('div', $header, ['class' => 'panel-heading']);
    $group[] = Html::tag('div', $content, $options);
    return implode("\n", $group);
}
renderItems() public method

Renders collapsible items as specified on $items.

public string renderItems ( )
return string

The rendering result
throws \yii\base\InvalidConfigException

if label isn't specified

 

                public function renderItems()
{
    $items = [];
    $index = 0;
    foreach ($this->items as $key => $item) {
        if (!is_array($item)) {
            $item = ['content' => $item];
        }
        if (!array_key_exists('label', $item)) {
            if (is_int($key)) {
                throw new InvalidConfigException("The 'label' option is required.");
            } else {
                $item['label'] = $key;
            }
        }
        $header = $item['label'];
        $options = ArrayHelper::getValue($item, 'options', []);
        Html::addCssClass($options, ['panel' => 'panel', 'widget' => 'panel-default']);
        $items[] = Html::tag('div', $this->renderItem($header, $item, ++$index), $options);
    }
    return implode("\n", $items);
}
run() public method

Renders the widget.

public void run ( )

                public function run()
{
    $this->registerPlugin('collapse');
    return implode("\n", [
        Html::beginTag('div', $this->options),
        $this->renderItems(),
        Html::endTag('div')
    ]) . "\n";
}