Interface DockHandle

The dock's public API. mount(opts) returns this object; companions reach it via findDock() or by reading _spektrumDock off the dock element.

interface DockHandle {
    panels: Map<string, DockPanelHandle>;
    collapse(): void;
    expand(): void;
    registerPanel(opts: DockPanelOptions): DockPanelHandle;
    setActive(id: string): void;
    setSide(side: DockSide): void;
    unmount(): void;
}

Index

Properties

Methods

collapse expand registerPanel setActive setSide unmount

Properties

`Readonly`panels

panels: Map<string, DockPanelHandle>

Live Map<id, DockPanelHandle> of registered panels. Read-only by convention; mutate via registerPanel / detach.

Methods

collapse

collapse(): void
Shrink to the floating chip (with the active-panel-count badge).

Returns void
- Defined in companions/spektrum-dock.d.ts:62

expand

expand(): void
Open the panel body (no-op if already open).

Returns void
- Defined in companions/spektrum-dock.d.ts:60

registerPanel

registerPanel(opts: DockPanelOptions): DockPanelHandle
Add a panel. Returns a handle the caller uses to render and clean up.
Parameters
- opts: DockPanelOptions
Returns DockPanelHandle
- Defined in companions/spektrum-dock.d.ts:58

setActive

setActive(id: string): void
Activate a panel by id (no-op if id not registered).
Parameters
- id: string
Returns void
- Defined in companions/spektrum-dock.d.ts:66

setSide

setSide(side: DockSide): void
Switch dock side at runtime.
Parameters
- side: DockSide
Returns void
- Defined in companions/spektrum-dock.d.ts:64

unmount

unmount(): void
Close every registered panel via its onClose, then remove the dock.

Returns void
- Defined in companions/spektrum-dock.d.ts:71