pivotick - v2.0.1
    Preparing search index...

    Interface RegisteredDockTab

    A DockTab once registered: its id is resolved.

    interface RegisteredDockTab {
        icon?: string;
        id: string;
        label: string;
        onActivate?: (tab: DockTabHandle) => void;
        onDeactivate?: (tab: DockTabHandle) => void;
        order?: number;
        render: (tab: DockTabHandle) => HTMLElement;
        toolbar?: (tab: DockTabHandle) => HTMLElement | HTMLElement[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    icon?: string

    A glyph drawn before the label in the strip, marking where the pane came from.

    An SVG string, injected with innerHTML and not sanitised — it must be trusted, exactly like PivotDefinition.icon. Useful when several tabs are the same kind of pane: four candidate reviews and a data table read as one list of five otherwise.

    id: string

    Stable identity: what removeDockTab / activateDockTab take, and the data-tab written onto the strip's button.

    an auto-generated pvt-dock-tab-N

    label: string

    The strip's label, used verbatim (so it can be translated).

    onActivate?: (tab: DockTabHandle) => void

    Called when this tab comes to the front, and when it leaves. A tab that watches live data should stop working in onDeactivate and catch up in onActivate: nothing else tells it that it is off screen.

    onDeactivate?: (tab: DockTabHandle) => void
    order?: number

    Display order in the strip, ascending. Equal orders keep registration order — and since plugins install after the UI is built, a plugin's tabs land after the built-in ones without having to say so.

    0
    
    render: (tab: DockTabHandle) => HTMLElement

    Build the pane's body. Called once, lazily, the first time the tab comes to the front — a tab nobody opens costs nothing. The element is kept and re-attached on later activations, so it holds its own state (scroll position included).

    toolbar?: (tab: DockTabHandle) => HTMLElement | HTMLElement[]

    Build this tab's header controls, laid out as part of the dock's header row. Re-invoked on every activation, so the controls can reflect the tab's current state.

    A pane with several views of its own draws the switch here. Two public classes give it the same look the built-in table has — pvt-dock-views on the strip, pvt-dock-view on each button, active on the current one — so it stays a pill group beside the dock's own tabs and follows the theme.