Interface TabsController

Headless Tabs controller.

interface TabsController {
    destroy(): void;
    focus(id: string, details?: ChangeDetails<TabsChangeReason>): void;
    getSnapshot(): Readonly<TSnapshot>;
    handleKeyDown(id: string, event: KeyboardEvent): void;
    off<TKey extends keyof TabsEvents>(
        type: TKey,
        listener: RuntimeEventListener<TabsEvents[TKey]>,
    ): void;
    on<TKey extends keyof TabsEvents>(
        type: TKey,
        listener: RuntimeEventListener<TabsEvents[TKey]>,
    ): Unsubscribe;
    once<TKey extends keyof TabsEvents>(
        type: TKey,
        listener: RuntimeEventListener<TabsEvents[TKey]>,
    ): Unsubscribe;
    registerTab(item: TabItem, element?: HTMLElement): () => void;
    select(id: string, details?: ChangeDetails<TabsChangeReason>): void;
    subscribe(listener: SnapshotListener<TabsSnapshot>): Unsubscribe;
}

Hierarchy (View Summary)

RuntimeController<TabsSnapshot>
RuntimeEventSource<TabsEvents>
- TabsController

Index

Methods

destroy focus getSnapshot handleKeyDown off on once registerTab select subscribe

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(id: string, details?: ChangeDetails<TabsChangeReason>): void
Focuses an enabled tab, selecting it in automatic mode.
Parameters
- id: string
- Optionaldetails: ChangeDetails<TabsChangeReason>
Returns void
- Defined in components/tabs.ts:104

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

handleKeyDown

handleKeyDown(id: string, event: KeyboardEvent): void
Handles orientation-aware Arrow keys, Home, End, Enter, and Space.
Parameters
- id: string
- event: KeyboardEvent
Returns void
- Defined in components/tabs.ts:106

off

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

on

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

once

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

registerTab

registerTab(item: TabItem, element?: HTMLElement): () => void
Registers a dynamic tab and optional focusable tab element.
Parameters
- item: TabItem
- Optionalelement: HTMLElement
Returns () => void
- Defined in components/tabs.ts:100

select

select(id: string, details?: ChangeDetails<TabsChangeReason>): void
Selects an enabled tab and synchronizes roving focus.
Parameters
- id: string
- Optionaldetails: ChangeDetails<TabsChangeReason>
Returns void
- Defined in components/tabs.ts:102

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