Interface TreeController

Headless hierarchical Tree View controller.

interface TreeController {
    destroy(): void;
    getSnapshot(): Readonly<TSnapshot>;
    handleKeyDown(event: KeyboardEvent): void;
    off<TKey extends keyof TreeEvents>(
        type: TKey,
        listener: RuntimeEventListener<TreeEvents[TKey]>,
    ): void;
    on<TKey extends keyof TreeEvents>(
        type: TKey,
        listener: RuntimeEventListener<TreeEvents[TKey]>,
    ): Unsubscribe;
    once<TKey extends keyof TreeEvents>(
        type: TKey,
        listener: RuntimeEventListener<TreeEvents[TKey]>,
    ): Unsubscribe;
    registerNode(node: TreeNode): () => void;
    select(id: string, details?: ChangeDetails<TreeChangeReason>): void;
    setActive(id: string | null): void;
    subscribe(listener: SnapshotListener<TreeSnapshot>): Unsubscribe;
    toggle(id: string, details?: ChangeDetails<TreeChangeReason>): void;
}

Hierarchy (View Summary)

RuntimeController<TreeSnapshot>
RuntimeEventSource<TreeEvents>
- TreeController

Index

Methods

destroy getSnapshot handleKeyDown off on once registerNode select setActive 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

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(event: KeyboardEvent): void
Handles Up/Down/Left/Right, Home/End, typeahead, Enter, and Space.
Parameters
- event: KeyboardEvent
Returns void
- Defined in components/tree.ts:128

off

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

on

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

once

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

registerNode

registerNode(node: TreeNode): () => void
Registers or replaces a dynamic node and returns scoped cleanup.
Parameters
- node: TreeNode
Returns () => void
- Defined in components/tree.ts:120

select

select(id: string, details?: ChangeDetails<TreeChangeReason>): void
Selects or toggles an enabled node.
Parameters
- id: string
- Optionaldetails: ChangeDetails<TreeChangeReason>
Returns void
- Defined in components/tree.ts:124

setActive

setActive(id: string | null): void
Moves the active node without changing selection.
Parameters
- id: string | null
Returns void
- Defined in components/tree.ts:126

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

toggle

toggle(id: string, details?: ChangeDetails<TreeChangeReason>): void
Expands or collapses a branch.
Parameters
- id: string
- Optionaldetails: ChangeDetails<TreeChangeReason>
Returns void
- Defined in components/tree.ts:122