AccordionItem

API reference › Bootstrap 6 › item › AccordionItem

final readonly class	`yii2\extensions\bootstrap6\item\AccordionItem`
Uses traits	`ItemTrait`
Source	`src/item/AccordionItem.php`

Represents an Accordion item: a <details> element with its <summary> label and .accordion-body content.

Properties

Property	Type	Description	Defined by
`$bodyOptions` readonly constructor	`array<array-key, mixed>`	HTML attributes of the `.accordion-body` element. Default: `[]`.	`AccordionItem`
`$content` readonly constructor	`string\|Stringable`	Content of the `.accordion-body` element (not encoded).	`AccordionItem`
`$encode` readonly constructor	`bool\|null`	Whether to HTML-encode `$label`, or `null` to use `Accordion::$encodeLabels`. Default: `null`.	`AccordionItem`
`$headerOptions` readonly constructor	`array<array-key, mixed>`	HTML attributes of the `<summary>` element. Default: `[]`.	`AccordionItem`
`$label` readonly constructor	`string\|Stringable`	Content of the `<summary>` element.	`AccordionItem`
`$open` readonly constructor	`bool`	Whether the item is initially expanded. Default: `false`.	`AccordionItem`
`$options` readonly constructor	`array<array-key, mixed>`	HTML attributes of the `<details>` element. Default: `[]`.	`AccordionItem`
`$visible` readonly constructor	`bool`	Whether to render the item. Default: `true`.	`AccordionItem`

Methods

Method	Description	Defined by
`fromArray()` static	Creates an item from the array configuration documented in `Accordion::$items`.	`AccordionItem`
`to()` static	Creates an item.	`AccordionItem`
`withBodyOptions()`	Returns a copy with the given `.accordion-body` attributes.	`AccordionItem`
`withContent()`	Returns a copy with the given content.	`AccordionItem`
`withEncode()`	Returns a copy with the given encoding flag.	`AccordionItem`
`withHeaderOptions()`	Returns a copy with the given `<summary>` attributes.	`AccordionItem`
`withLabel()`	Returns a copy with the given label.	`AccordionItem`
`withOpen()`	Returns a copy with the given expanded state.	`AccordionItem`
`withOptions()`	Returns a copy with the given `<details>` attributes.	`AccordionItem`
`withVisible()`	Returns a copy with the given visibility.	`AccordionItem`

Method details

fromArray()

public static function fromArray(array<array-key, mixed> $config): self

Creates an item from the array configuration documented in Accordion::$items.

Only true opens the item and only false hides it; an encode other than null is compared with false; attribute keys that are not arrays are ignored.

Parameters

Parameter	Type	Description
`$config`	`array<array-key, mixed>`	Item configuration.

Returns

self

Throws

yii\base\InvalidConfigException: if the item has no string|Stringable label or content.

to()

public static function to(string|Stringable $label, string|Stringable $content): self

Creates an item.

Parameters

Parameter	Type	Description
`$label`	`string\|Stringable`	Content of the `<summary>` element.
`$content`	`string\|Stringable`	Content of the `.accordion-body` element (not encoded).

Returns

self

withBodyOptions()

public function withBodyOptions(array<array-key, mixed> $bodyOptions): self

Returns a copy with the given .accordion-body attributes.

Parameters

Parameter	Type	Description
`$bodyOptions`	`array<array-key, mixed>`	HTML attributes of the `.accordion-body` element.

Returns

self

withContent()

public function withContent(string|Stringable $content): self

Returns a copy with the given content.

Parameters

Parameter	Type	Description
`$content`	`string\|Stringable`

Returns

self

withEncode()

public function withEncode(bool|null $encode): self

Returns a copy with the given encoding flag.

Parameters

Parameter	Type	Description
`$encode`	`bool\|null`

Returns

self

withHeaderOptions()

public function withHeaderOptions(array<array-key, mixed> $headerOptions): self

Returns a copy with the given <summary> attributes.

Parameters

Parameter	Type	Description
`$headerOptions`	`array<array-key, mixed>`	HTML attributes of the `<summary>` element.

Returns

self

withLabel()

public function withLabel(string|Stringable $label): self

Returns a copy with the given label.

Parameters

Parameter	Type	Description
`$label`	`string\|Stringable`

Returns

self

withOpen()

public function withOpen(bool $open): self

Returns a copy with the given expanded state.

Parameters

Parameter	Type	Description
`$open`	`bool`

Returns

self

withOptions()

public function withOptions(array<array-key, mixed> $options): self

Returns a copy with the given <details> attributes.

Parameters

Parameter	Type	Description
`$options`	`array<array-key, mixed>`	HTML attributes of the `<details>` element.

Returns

self

withVisible()

public function withVisible(bool $visible): self

Returns a copy with the given visibility.

Parameters

Parameter	Type	Description
`$visible`	`bool`

Returns

self