Interface ToggleAccordionSectionOptions<TSection>

Options accepted by toggleAccordionSection.

interface ToggleAccordionSectionOptions<
    TSection extends AccordionSection = AccordionSection,
> {
    allowMultiple?: boolean;
    expandedIds?: readonly string[];
    sectionId: string;
    sections: readonly TSection[];
}

Type Parameters

TSection extends AccordionSection = AccordionSection

Index

Properties

allowMultiple? expandedIds? sectionId sections

Properties

`Optional`allowMultiple

allowMultiple?: boolean

Whether more than one section may be expanded.

Default Value

false

`Optional`expandedIds

expandedIds?: readonly string[]

Current expanded section identifiers.

sectionId

sectionId: string

Section to toggle. Disabled or unknown sections leave state unchanged.

sections

sections: readonly TSection[]

Ordered sections.