Interface AccordionController

Headless Accordion controller.

interface AccordionController {
    destroy(): void;
    focus(itemId: string): void;
    getSnapshot(): Readonly<TSnapshot>;
    handleTriggerKeyDown(itemId: string, event: KeyboardEvent): void;
    off<TKey extends keyof AccordionEvents>(
        type: TKey,
        listener: RuntimeEventListener<AccordionEvents[TKey]>,
    ): void;
    on<TKey extends keyof AccordionEvents>(
        type: TKey,
        listener: RuntimeEventListener<AccordionEvents[TKey]>,
    ): Unsubscribe;
    once<TKey extends keyof AccordionEvents>(
        type: TKey,
        listener: RuntimeEventListener<AccordionEvents[TKey]>,
    ): Unsubscribe;
    registerItem(item: AccordionItem, trigger?: HTMLElement): () => void;
    subscribe(listener: SnapshotListener<AccordionSnapshot>): Unsubscribe;
    toggle(
        itemId: string,
        details?: ChangeDetails<AccordionChangeReason>,
    ): void;
}

Hierarchy (View Summary)

RuntimeController<AccordionSnapshot>
RuntimeEventSource<AccordionEvents>
- AccordionController

Index

Methods

destroy focus getSnapshot handleTriggerKeyDown off on once registerItem subscribe toggle

Methods

destroy

destroy(): void
Releases owned listeners, timers, observers, focus scopes, and subscriptions.

Returns void
Inherited from RuntimeController.destroy
- Defined in core/types.ts:21

focus

focus(itemId: string): void
Focuses a registered enabled trigger by ID.
Parameters
- itemId: string
Returns void
- Defined in components/accordion.ts:100

getSnapshot

getSnapshot(): Readonly<TSnapshot>
Returns the current immutable snapshot, including after destruction.

Returns Readonly<TSnapshot>
Inherited from RuntimeController.getSnapshot
- Defined in core/types.ts:17

handleTriggerKeyDown

handleTriggerKeyDown(itemId: string, event: KeyboardEvent): void
Handles Arrow, Home, End, Enter, and Space on an item trigger.
Parameters
- itemId: string
- event: KeyboardEvent
Returns void
- Defined in components/accordion.ts:98

off

off<TKey extends keyof AccordionEvents>(
type: TKey,
listener: RuntimeEventListener<AccordionEvents[TKey]>,
): void
Removes a previously registered listener.
Type Parameters
- TKey extends keyof AccordionEvents
Parameters
- type: TKey
- listener: RuntimeEventListener<AccordionEvents[TKey]>
Returns void
Inherited from RuntimeEventSource.off
- Defined in core/types.ts:65

on

on<TKey extends keyof AccordionEvents>(
type: TKey,
listener: RuntimeEventListener<AccordionEvents[TKey]>,
): Unsubscribe
Registers a listener and returns an idempotent unsubscribe function.
Type Parameters
- TKey extends keyof AccordionEvents
Parameters
- type: TKey
- listener: RuntimeEventListener<AccordionEvents[TKey]>
Returns Unsubscribe
Inherited from RuntimeEventSource.on
- Defined in core/types.ts:60

once

once<TKey extends keyof AccordionEvents>(
type: TKey,
listener: RuntimeEventListener<AccordionEvents[TKey]>,
): Unsubscribe
Registers a listener that is automatically removed after its first call.
Type Parameters
- TKey extends keyof AccordionEvents
Parameters
- type: TKey
- listener: RuntimeEventListener<AccordionEvents[TKey]>
Returns Unsubscribe
Inherited from RuntimeEventSource.once
- Defined in core/types.ts:67

registerItem

registerItem(item: AccordionItem, trigger?: HTMLElement): () => void
Registers an item and optional trigger element for roving focus.
Parameters
- item: AccordionItem
- Optionaltrigger: HTMLElement
Returns () => void
- Defined in components/accordion.ts:94

subscribe(listener: SnapshotListener<AccordionSnapshot>): Unsubscribe
Subscribes to future distinct snapshots without synchronously invoking the listener.
Parameters
- listener: SnapshotListener<AccordionSnapshot>
Returns Unsubscribe
Inherited from RuntimeController.subscribe
- Defined in core/types.ts:19

toggle

toggle(itemId: string, details?: ChangeDetails<AccordionChangeReason>): void
Toggles an item according to single/multiple and collapsible rules.
Parameters
- itemId: string
- Optionaldetails: ChangeDetails<AccordionChangeReason>
Returns void
- Defined in components/accordion.ts:96