Class yii\jui\Accordion

Inheritanceyii\jui\Accordion » yii\jui\Widget » yii\base\Widget
Available since version2.0

Accordion renders an accordion jQuery UI widget.

For example:

echo Accordion::widget([
    'items' => [
        [
            'header' => 'Section 1',
            'content' => 'Mauris mauris ante, blandit et, ultrices a, suscipit eget...',
        ],
        [
            'header' => 'Section 2',
            'headerOptions' => ['tag' => 'h3'],
            'content' => 'Sed non urna. Phasellus eu ligula. Vestibulum sit amet purus...',
            'options' => ['tag' => 'div'],
        ],
    ],
    'options' => ['tag' => 'div'],
    'itemOptions' => ['tag' => 'div'],
    'headerOptions' => ['tag' => 'h3'],
    'clientOptions' => ['collapsible' => false],
]);

See also http://api.jqueryui.com/accordion/.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$clientEvents array The event handlers for the underlying jQuery UI widget. yii\jui\Widget
$clientOptions array The options for the underlying jQuery UI widget. yii\jui\Widget
$headerOptions array List of HTML attributes for the item header container tags. yii\jui\Accordion
$itemOptions array List of HTML attributes for the item container tags. yii\jui\Accordion
$items array List of collapsible items. yii\jui\Accordion
$options array The HTML attributes for the widget container tag. yii\jui\Accordion

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$clientEventMap array Event names mapped to what should be specified in `. yii\jui\Widget

Public Methods

Hide inherited methods

MethodDescriptionDefined By
init() Initializes the widget. yii\jui\Widget
run() Renders the widget. yii\jui\Accordion

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
registerClientEvents() Registers a specific jQuery UI widget events yii\jui\Widget
registerClientOptions() Registers a specific jQuery UI widget options yii\jui\Widget
registerWidget() Registers a specific jQuery UI widget asset bundle, initializes it with client options and registers related events yii\jui\Widget
renderItems() Renders collapsible items as specified on $items. yii\jui\Accordion

Property Details

$headerOptions public property

List of HTML attributes for the item header container tags. This will be overwritten by the "headerOptions" set in individual $items. The following special options are recognized:

  • tag: string, defaults to "h3", the tag name of the item container tags.

See also \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $headerOptions = []
$itemOptions public property

List of HTML attributes for the item container tags. This will be overwritten by the "options" set in individual $items. The following special options are recognized:

  • tag: string, defaults to "div", the tag name of the item container tags.

See also \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $itemOptions = []
$items public property

List of collapsible items. Each item can be an array of the following structure:

[
    'header' => 'Item header',
    'content' => 'Item content',
    // the HTML attributes of the item header container tag. This will overwrite "headerOptions".
    'headerOptions' => [],
    // the HTML attributes of the item container tag. This will overwrite "itemOptions".
    'options' => [],
]
public array $items = []
$options public property

The HTML attributes for the widget container tag. The following special options are recognized:

  • tag: string, defaults to "div", the tag name of the container tag of this widget

See also \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $options = []

Method Details

renderItems() protected method

Renders collapsible items as specified on $items.

protected string renderItems ( )
return string

The rendering result.

throws \yii\jui\InvalidConfigException.
run() public method

Renders the widget.

public void run ( )