Interface DisclosureController

Headless Disclosure command and event surface.

interface DisclosureController {
    collapse(details?: ChangeDetails<DisclosureChangeReason>): void;
    destroy(): void;
    expand(details?: ChangeDetails<DisclosureChangeReason>): void;
    getSnapshot(): Readonly<TSnapshot>;
    handleTriggerClick(event: MouseEvent): void;
    handleTriggerKeyDown(event: KeyboardEvent): void;
    off<TKey extends keyof DisclosureEvents>(
        type: TKey,
        listener: RuntimeEventListener<DisclosureEvents[TKey]>,
    ): void;
    on<TKey extends keyof DisclosureEvents>(
        type: TKey,
        listener: RuntimeEventListener<DisclosureEvents[TKey]>,
    ): Unsubscribe;
    once<TKey extends keyof DisclosureEvents>(
        type: TKey,
        listener: RuntimeEventListener<DisclosureEvents[TKey]>,
    ): Unsubscribe;
    setDisabled(disabled: boolean): void;
    subscribe(listener: SnapshotListener<DisclosureSnapshot>): Unsubscribe;
    toggle(details?: ChangeDetails<DisclosureChangeReason>): void;
}

Hierarchy (View Summary)

RuntimeController<DisclosureSnapshot>
RuntimeEventSource<DisclosureEvents>
- DisclosureController

Index

Methods

collapse destroy expand getSnapshot handleTriggerClick handleTriggerKeyDown off on once setDisabled subscribe toggle

Methods

collapse

collapse(details?: ChangeDetails<DisclosureChangeReason>): void
Collapses unless disabled, already collapsed, destroyed, or cancelled.
Parameters
- Optionaldetails: ChangeDetails<DisclosureChangeReason>
Returns void
- Defined in components/disclosure.ts:94

destroy

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

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

expand

expand(details?: ChangeDetails<DisclosureChangeReason>): void
Expands unless disabled, already expanded, destroyed, or cancelled.
Parameters
- Optionaldetails: ChangeDetails<DisclosureChangeReason>
Returns void
- Defined in components/disclosure.ts:92

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

handleTriggerClick

handleTriggerClick(event: MouseEvent): void
Handles click activation from consumer-rendered trigger markup.
Parameters
- event: MouseEvent
Returns void
- Defined in components/disclosure.ts:100

handleTriggerKeyDown

handleTriggerKeyDown(event: KeyboardEvent): void
Handles Enter and Space activation from non-native trigger integrations.
Parameters
- event: KeyboardEvent
Returns void
- Defined in components/disclosure.ts:102

off

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

on

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

once

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

setDisabled

setDisabled(disabled: boolean): void
Updates interaction-disabled state without replacing the controller.
Parameters
- disabled: boolean
Returns void
- Defined in components/disclosure.ts:98

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

toggle

toggle(details?: ChangeDetails<DisclosureChangeReason>): void
Requests the opposite state with a typed cause.
Parameters
- Optionaldetails: ChangeDetails<DisclosureChangeReason>
Returns void
- Defined in components/disclosure.ts:96

Interface DisclosureController

Hierarchy (View Summary)

Index

Methods

Methods

collapse

Parameters

Returns void

destroy

Returns void

expand

Parameters

Returns void

getSnapshot

Returns Readonly<TSnapshot>

handleTriggerClick

Parameters

Returns void

handleTriggerKeyDown

Parameters

Returns void

off

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns Unsubscribe

once

Type Parameters

Parameters

Returns Unsubscribe

setDisabled

Parameters

Returns void

subscribe

Parameters

Returns Unsubscribe

toggle

Parameters

Returns void

Settings

On This Page