Class yii\bootstrap4\Accordion

Inheritanceyii\bootstrap4\Accordion » yii\bootstrap4\Widget » yii\base\Widget
Uses Traitsyii\bootstrap4\BootstrapWidgetTrait
Source Code https://github.com/yiisoft/yii2-bootstrap4/blob/master/src/Accordion.php

Accordion renders an accordion bootstrap javascript component.

For example:

echo Accordion::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' => [...],
            'expand' => true,
        ],
        // if you want to swap out .card-block 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 https://getbootstrap.com/docs/4.2/components/collapse/#accordion-example.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$autoCloseItems boolean Whether to close other items if an item is opened. yii\bootstrap4\Accordion
$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
$encodeLabels boolean Whether the labels for header items should be HTML-encoded. yii\bootstrap4\Accordion
$itemToggleOptions array The HTML options for the item toggle tag. yii\bootstrap4\Accordion
$items array List of groups in the collapse widget. yii\bootstrap4\Accordion
$options array The HTML attributes for the widget container tag. yii\bootstrap4\Widget

Public Methods

Hide inherited methods

MethodDescriptionDefined By
getView() yii\bootstrap4\BootstrapWidgetTrait
init() Initializes the widget. yii\bootstrap4\BootstrapWidgetTrait
renderItem() Renders a single collapsible item group yii\bootstrap4\Accordion
renderItems() Renders collapsible items as specified on $items. yii\bootstrap4\Accordion
run() yii\bootstrap4\Accordion

Protected Methods

Hide inherited methods

MethodDescriptionDefined 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

$autoCloseItems public property

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

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',
]
$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 Accordion::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

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
throws Exception
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

run() public method

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