dockview-core 7.0.4 → 8.1.0

package/dist/esm/api/component.api.d.ts

@@ -1,640 +0,0 @@
-import { DockviewActivePanelChangeEvent, DockviewLayoutMutationEvent, DockviewMaximizedGroupChangeEvent, DockviewPopoutGroupOptions, FloatingGroupOptions, GroupNavigationDirection, IDockviewComponent, MovePanelEvent, PopoutGroup, PopoutGroupChangePositionEvent, PopoutGroupChangeSizeEvent, SerializedDockview } from '../dockview/dockviewComponent';
-import { AddGroupOptions, AddPanelOptions, DockviewComponentOptions, DockviewDndOverlayEvent, MovementOptions } from '../dockview/options';
-import { Parameters } from '../panel/types';
-import { Direction } from '../gridview/baseComponentGridview';
-import { AddGridviewComponentOptions, IGridviewComponent, SerializedGridviewComponent } from '../gridview/gridviewComponent';
-import { IGridviewPanel } from '../gridview/gridviewPanel';
-import { AddPaneviewComponentOptions, SerializedPaneview, IPaneviewComponent } from '../paneview/paneviewComponent';
-import { IPaneviewPanel } from '../paneview/paneviewPanel';
-import { AddSplitviewComponentOptions, ISplitviewComponent, SerializedSplitview } from '../splitview/splitviewComponent';
-import { IView, Orientation, Sizing } from '../splitview/splitview';
-import { ISplitviewPanel } from '../splitview/splitviewPanel';
-import { DockviewGroupPanel, IDockviewGroupPanel } from '../dockview/dockviewGroupPanel';
-import { Event } from '../events';
-import { IDockviewPanel } from '../dockview/dockviewPanel';
-import { PaneviewDidDropEvent } from '../paneview/draggablePaneviewPanel';
-import { GroupDragEvent, TabDragEvent } from '../dockview/components/titlebar/tabsContainer';
-import { DockviewDidDropEvent, DockviewWillDropEvent } from '../dockview/dockviewGroupPanelModel';
-import { DockviewWillShowOverlayLocationEvent, DockviewTabGroupChangeEvent, DockviewTabGroupCollapsedChangeEvent, DockviewTabGroupPanelChangeEvent } from '../dockview/events';
-import { ITabGroup } from '../dockview/tabGroup';
-import { DockviewTabGroupColorEntry } from '../dockview/tabGroupAccent';
-import { PaneviewComponentOptions, PaneviewDndOverlayEvent } from '../paneview/options';
-import { SplitviewComponentOptions } from '../splitview/options';
-import { GridviewComponentOptions } from '../gridview/options';
-import { EdgeGroupPosition, EdgeGroupOptions } from '../dockview/dockviewShell';
-import { DockviewGroupPanelApi } from './dockviewGroupPanelApi';
-export interface CommonApi<T = any> {
-    readonly height: number;
-    readonly width: number;
-    readonly onDidLayoutChange: Event<void>;
-    readonly onDidLayoutFromJSON: Event<void>;
-    focus(): void;
-    layout(width: number, height: number): void;
-    fromJSON(data: T): void;
-    toJSON(): T;
-    clear(): void;
-    dispose(): void;
-}
-export declare class SplitviewApi implements CommonApi<SerializedSplitview> {
-    private readonly component;
-    /**
-     * The minimum size  the component can reach where size is measured in the direction of orientation provided.
-     */
-    get minimumSize(): number;
-    /**
-     * The maximum size the component can reach where size is measured in the direction of orientation provided.
-     */
-    get maximumSize(): number;
-    /**
-     * Width of the component.
-     */
-    get width(): number;
-    /**
-     * Height of the component.
-     */
-    get height(): number;
-    /**
-     * The current number of panels.
-     */
-    get length(): number;
-    /**
-     * The current orientation of the component.
-     */
-    get orientation(): Orientation;
-    /**
-     * The list of current panels.
-     */
-    get panels(): ISplitviewPanel[];
-    /**
-     * Invoked after a layout is loaded through the `fromJSON` method.
-     */
-    get onDidLayoutFromJSON(): Event<void>;
-    /**
-     * Invoked whenever any aspect of the layout changes.
-     * If listening to this event it may be worth debouncing ouputs.
-     */
-    get onDidLayoutChange(): Event<void>;
-    /**
-     * Invoked when a view is added.
-     */
-    get onDidAddView(): Event<IView>;
-    /**
-     * Invoked when a view is removed.
-     */
-    get onDidRemoveView(): Event<IView>;
-    constructor(component: ISplitviewComponent);
-    /**
-     * Removes an existing panel and optionally provide a `Sizing` method
-     * for the subsequent resize.
-     */
-    removePanel(panel: ISplitviewPanel, sizing?: Sizing): void;
-    /**
-     * Focus the component.
-     */
-    focus(): void;
-    /**
-     * Get the reference to a panel given it's `string` id.
-     */
-    getPanel(id: string): ISplitviewPanel | undefined;
-    /**
-     * Layout the panel with a width and height.
-     */
-    layout(width: number, height: number): void;
-    /**
-     * Add a new panel and return the created instance.
-     */
-    addPanel<T extends object = Parameters>(options: AddSplitviewComponentOptions<T>): ISplitviewPanel;
-    /**
-     * Move a panel given it's current and desired index.
-     */
-    movePanel(from: number, to: number): void;
-    /**
-     * Deserialize a layout to built a splitivew.
-     */
-    fromJSON(data: SerializedSplitview): void;
-    /** Serialize a layout */
-    toJSON(): SerializedSplitview;
-    /**
-     * Remove all panels and clear the component.
-     */
-    clear(): void;
-    /**
-     * Update configuratable options.
-     */
-    updateOptions(options: Partial<SplitviewComponentOptions>): void;
-    /**
-     * Release resources and teardown component. Do not call when using framework versions of dockview.
-     */
-    dispose(): void;
-}
-export declare class PaneviewApi implements CommonApi<SerializedPaneview> {
-    private readonly component;
-    /**
-     * The minimum size  the component can reach where size is measured in the direction of orientation provided.
-     */
-    get minimumSize(): number;
-    /**
-     * The maximum size the component can reach where size is measured in the direction of orientation provided.
-     */
-    get maximumSize(): number;
-    /**
-     * Width of the component.
-     */
-    get width(): number;
-    /**
-     * Height of the component.
-     */
-    get height(): number;
-    /**
-     * All panel objects.
-     */
-    get panels(): IPaneviewPanel[];
-    /**
-     * Invoked when any layout change occures, an aggregation of many events.
-     */
-    get onDidLayoutChange(): Event<void>;
-    /**
-     * Invoked after a layout is deserialzied using the `fromJSON` method.
-     */
-    get onDidLayoutFromJSON(): Event<void>;
-    /**
-     * Invoked when a panel is added. May be called multiple times when moving panels.
-     */
-    get onDidAddView(): Event<IPaneviewPanel>;
-    /**
-     * Invoked when a panel is removed. May be called multiple times when moving panels.
-     */
-    get onDidRemoveView(): Event<IPaneviewPanel>;
-    /**
-     * Invoked when a Drag'n'Drop event occurs that the component was unable to handle. Exposed for custom Drag'n'Drop functionality.
-     */
-    get onDidDrop(): Event<PaneviewDidDropEvent>;
-    get onUnhandledDragOver(): Event<PaneviewDndOverlayEvent>;
-    constructor(component: IPaneviewComponent);
-    /**
-     * Remove a panel given the panel object.
-     */
-    removePanel(panel: IPaneviewPanel): void;
-    /**
-     * Get a panel object given a `string` id. May return `undefined`.
-     */
-    getPanel(id: string): IPaneviewPanel | undefined;
-    /**
-     * Move a panel given it's current and desired index.
-     */
-    movePanel(from: number, to: number): void;
-    /**
-     *  Focus the component. Will try to focus an active panel if one exists.
-     */
-    focus(): void;
-    /**
-     * Force resize the component to an exact width and height. Read about auto-resizing before using.
-     */
-    layout(width: number, height: number): void;
-    /**
-     * Add a panel and return the created object.
-     */
-    addPanel<T extends object = Parameters>(options: AddPaneviewComponentOptions<T>): IPaneviewPanel;
-    /**
-     * Create a component from a serialized object.
-     */
-    fromJSON(data: SerializedPaneview): void;
-    /**
-     * Create a serialized object of the current component.
-     */
-    toJSON(): SerializedPaneview;
-    /**
-     * Reset the component back to an empty and default state.
-     */
-    clear(): void;
-    /**
-     * Update configuratable options.
-     */
-    updateOptions(options: Partial<PaneviewComponentOptions>): void;
-    /**
-     * Release resources and teardown component. Do not call when using framework versions of dockview.
-     */
-    dispose(): void;
-}
-export declare class GridviewApi implements CommonApi<SerializedGridviewComponent> {
-    private readonly component;
-    /**
-     * Width of the component.
-     */
-    get width(): number;
-    /**
-     * Height of the component.
-     */
-    get height(): number;
-    /**
-     * Minimum height of the component.
-     */
-    get minimumHeight(): number;
-    /**
-     * Maximum height of the component.
-     */
-    get maximumHeight(): number;
-    /**
-     * Minimum width of the component.
-     */
-    get minimumWidth(): number;
-    /**
-     * Maximum width of the component.
-     */
-    get maximumWidth(): number;
-    /**
-     * Invoked when any layout change occures, an aggregation of many events.
-     */
-    get onDidLayoutChange(): Event<void>;
-    /**
-     * Invoked when a panel is added. May be called multiple times when moving panels.
-     */
-    get onDidAddPanel(): Event<IGridviewPanel>;
-    /**
-     * Invoked when a panel is removed. May be called multiple times when moving panels.
-     */
-    get onDidRemovePanel(): Event<IGridviewPanel>;
-    /**
-     * Invoked when the active panel changes. May be undefined if no panel is active.
-     */
-    get onDidActivePanelChange(): Event<IGridviewPanel | undefined>;
-    /**
-     * Invoked after a layout is deserialzied using the `fromJSON` method.
-     */
-    get onDidLayoutFromJSON(): Event<void>;
-    /**
-     * All panel objects.
-     */
-    get panels(): IGridviewPanel[];
-    /**
-     * Current orientation. Can be changed after initialization.
-     */
-    get orientation(): Orientation;
-    set orientation(value: Orientation);
-    constructor(component: IGridviewComponent);
-    /**
-     *  Focus the component. Will try to focus an active panel if one exists.
-     */
-    focus(): void;
-    /**
-     * Force resize the component to an exact width and height. Read about auto-resizing before using.
-     */
-    layout(width: number, height: number, force?: boolean): void;
-    /**
-     * Add a panel and return the created object.
-     */
-    addPanel<T extends object = Parameters>(options: AddGridviewComponentOptions<T>): IGridviewPanel;
-    /**
-     * Remove a panel given the panel object.
-     */
-    removePanel(panel: IGridviewPanel, sizing?: Sizing): void;
-    /**
-     * Move a panel in a particular direction relative to another panel.
-     */
-    movePanel(panel: IGridviewPanel, options: {
-        direction: Direction;
-        reference: string;
-        size?: number;
-    }): void;
-    /**
-     * Get a panel object given a `string` id. May return `undefined`.
-     */
-    getPanel(id: string): IGridviewPanel | undefined;
-    /**
-     * Create a component from a serialized object.
-     */
-    fromJSON(data: SerializedGridviewComponent): void;
-    /**
-     * Create a serialized object of the current component.
-     */
-    toJSON(): SerializedGridviewComponent;
-    /**
-     * Reset the component back to an empty and default state.
-     */
-    clear(): void;
-    updateOptions(options: Partial<GridviewComponentOptions>): void;
-    /**
-     * Release resources and teardown component. Do not call when using framework versions of dockview.
-     */
-    dispose(): void;
-}
-export interface DockviewGetTabGroupsOptions {
-    groupId: string;
-}
-export declare class DockviewApi implements CommonApi<SerializedDockview> {
-    private readonly component;
-    /**
-     * The unique identifier for this instance. Used to manage scope of Drag'n'Drop events.
-     */
-    get id(): string;
-    /**
-     * Width of the component.
-     */
-    get width(): number;
-    /**
-     * Height of the component.
-     */
-    get height(): number;
-    /**
-     * Minimum height of the component.
-     */
-    get minimumHeight(): number;
-    /**
-     * Maximum height of the component.
-     */
-    get maximumHeight(): number;
-    /**
-     * Minimum width of the component.
-     */
-    get minimumWidth(): number;
-    /**
-     * Maximum width of the component.
-     */
-    get maximumWidth(): number;
-    /**
-     * Total number of groups.
-     */
-    get size(): number;
-    /**
-     * The active tab-group color palette. Reflects the configured
-     * `tabGroupColors` option, or the built-in defaults when unset.
-     * Useful for custom chip renderers that want to roll their own
-     * picker UI.
-     */
-    get tabGroupColors(): readonly DockviewTabGroupColorEntry[];
-    /**
-     * Total number of panels.
-     */
-    get totalPanels(): number;
-    /**
-     * Invoked when the active group changes. May be undefined if no group is active.
-     */
-    get onDidActiveGroupChange(): Event<DockviewGroupPanel | undefined>;
-    /**
-     * Invoked when a group is added. May be called multiple times when moving groups.
-     */
-    get onDidAddGroup(): Event<DockviewGroupPanel>;
-    /**
-     * Invoked when a group is removed. May be called multiple times when moving groups.
-     */
-    get onDidRemoveGroup(): Event<DockviewGroupPanel>;
-    /**
-     * Invoked when the active panel changes. The event carries the active
-     * `panel` (may be undefined if no panel is active) and the
-     * {@link DockviewOrigin} (`'user'` vs `'api'`) of the change.
-     */
-    get onDidActivePanelChange(): Event<DockviewActivePanelChangeEvent>;
-    /**
-     * Invoked when a panel is added. May be called multiple times when moving panels.
-     */
-    get onDidAddPanel(): Event<IDockviewPanel>;
-    /**
-     * Invoked when a panel is removed. May be called multiple times when moving panels.
-     */
-    get onDidRemovePanel(): Event<IDockviewPanel>;
-    get onDidMovePanel(): Event<MovePanelEvent>;
-    /**
-     * Invoked after a layout is deserialzied using the `fromJSON` method.
-     */
-    get onDidLayoutFromJSON(): Event<void>;
-    /**
-     * Invoked when any layout change occures, an aggregation of many events.
-     */
-    get onDidLayoutChange(): Event<void>;
-    /**
-     * Invoked when a Drag'n'Drop event occurs that the component was unable to handle. Exposed for custom Drag'n'Drop functionality.
-     */
-    get onDidDrop(): Event<DockviewDidDropEvent>;
-    /**
-     * Invoked when a Drag'n'Drop event occurs but before dockview handles it giving the user an opportunity to intecept and
-     * prevent the event from occuring using the standard `preventDefault()` syntax.
-     *
-     * Preventing certain events may causes unexpected behaviours, use carefully.
-     */
-    get onWillDrop(): Event<DockviewWillDropEvent>;
-    /**
-     * Fires before each top-level structural layout mutation (add / remove /
-     * move / float / popout / maximize / load / clear). Compound operations
-     * (e.g. a drag) fire once. Pair with `onDidMutateLayout` to bracket a
-     * change — useful for undo/redo, autosave and dirty-tracking.
-     */
-    get onWillMutateLayout(): Event<DockviewLayoutMutationEvent>;
-    /** Fires after each top-level structural layout mutation. See `onWillMutateLayout`. */
-    get onDidMutateLayout(): Event<DockviewLayoutMutationEvent>;
-    /**
-     * Invoked before an overlay is shown indicating a drop target.
-     *
-     * Calling `event.preventDefault()` will prevent the overlay being shown and prevent
-     * the any subsequent drop event.
-     */
-    get onWillShowOverlay(): Event<DockviewWillShowOverlayLocationEvent>;
-    /**
-     * Invoked before a group is dragged.
-     *
-     * Calling `event.nativeEvent.preventDefault()` will prevent the group drag starting.
-     *
-     */
-    get onWillDragGroup(): Event<GroupDragEvent>;
-    /**
-     * Invoked before a panel is dragged.
-     *
-     * Calling `event.nativeEvent.preventDefault()` will prevent the panel drag starting.
-     */
-    get onWillDragPanel(): Event<TabDragEvent>;
-    get onUnhandledDragOver(): Event<DockviewDndOverlayEvent>;
-    get onDidPopoutGroupSizeChange(): Event<PopoutGroupChangeSizeEvent>;
-    get onDidPopoutGroupPositionChange(): Event<PopoutGroupChangePositionEvent>;
-    /**
-     * Fires when a popout group successfully opens in its own window, carrying
-     * the live `Window` handle. Use it to route focus or attach per-document
-     * listeners. Enumerate the current popouts at any time with `getPopouts()`.
-     */
-    get onDidAddPopoutGroup(): Event<PopoutGroup>;
-    /**
-     * Fires when a popout group is removed — whether the user closed its window
-     * or it was docked back programmatically. Symmetric with
-     * {@link onDidAddPopoutGroup}; not fired during component disposal.
-     */
-    get onDidRemovePopoutGroup(): Event<PopoutGroup>;
-    get onDidOpenPopoutWindowFail(): Event<void>;
-    /** Enumerate the popout groups currently open in their own windows. */
-    getPopouts(): PopoutGroup[];
-    /**
-     * Invoked when a tab group is created in any group.
-     */
-    get onDidCreateTabGroup(): Event<DockviewTabGroupChangeEvent>;
-    /**
-     * Invoked when a tab group is destroyed in any group.
-     */
-    get onDidDestroyTabGroup(): Event<DockviewTabGroupChangeEvent>;
-    /**
-     * Invoked when a panel is added to a tab group.
-     */
-    get onDidAddPanelToTabGroup(): Event<DockviewTabGroupPanelChangeEvent>;
-    /**
-     * Invoked when a panel is removed from a tab group.
-     */
-    get onDidRemovePanelFromTabGroup(): Event<DockviewTabGroupPanelChangeEvent>;
-    /**
-     * Invoked when a tab group's properties (label, color) change.
-     */
-    get onDidTabGroupChange(): Event<DockviewTabGroupChangeEvent>;
-    /**
-     * Invoked when a tab group is collapsed or expanded.
-     */
-    get onDidTabGroupCollapsedChange(): Event<DockviewTabGroupCollapsedChangeEvent>;
-    /**
-     * All panel objects.
-     */
-    get panels(): IDockviewPanel[];
-    /**
-     * All group objects.
-     */
-    get groups(): DockviewGroupPanel[];
-    /**
-     * The nearest grid group in a spatial direction from `group`, comparing
-     * group centre points — e.g. the group visually to the left. Floating and
-     * popout groups are ignored. Returns `undefined` when there is no group in
-     * that direction. Pair with `group.api.boundingBox` to build your own
-     * spatial navigation.
-     */
-    adjacentGroupInDirection(group: IDockviewGroupPanel, direction: GroupNavigationDirection): IDockviewGroupPanel | undefined;
-    /**
-     *  Active panel object.
-     */
-    get activePanel(): IDockviewPanel | undefined;
-    /**
-     * Active group object.
-     */
-    get activeGroup(): DockviewGroupPanel | undefined;
-    constructor(component: IDockviewComponent);
-    /**
-     *  Focus the component. Will try to focus an active panel if one exists.
-     */
-    focus(): void;
-    /**
-     * Get a panel object given a `string` id. May return `undefined`.
-     */
-    getPanel(id: string): IDockviewPanel | undefined;
-    /**
-     * Force resize the component to an exact width and height. Read about auto-resizing before using.
-     */
-    layout(width: number, height: number, force?: boolean): void;
-    /**
-     * Add a panel and return the created object.
-     */
-    addPanel<T extends object = Parameters>(options: AddPanelOptions<T>): IDockviewPanel;
-    /**
-     * Remove a panel given the panel object.
-     */
-    removePanel(panel: IDockviewPanel): void;
-    /**
-     * Add a group and return the created object.
-     */
-    addGroup(options?: AddGroupOptions): DockviewGroupPanel;
-    /**
-     * Close all groups and panels.
-     */
-    closeAllGroups(): void;
-    /**
-     * Remove a group and any panels within the group.
-     */
-    removeGroup(group: IDockviewGroupPanel): void;
-    /**
-     * Get a group object given a `string` id. May return undefined.
-     */
-    getGroup(id: string): IDockviewGroupPanel | undefined;
-    /**
-     * Add a floating group
-     */
-    addFloatingGroup(item: IDockviewPanel | DockviewGroupPanel, options?: FloatingGroupOptions): void;
-    /**
-     * Create a component from a serialized object.
-     */
-    fromJSON(data: SerializedDockview, options?: {
-        reuseExistingPanels: boolean;
-    }): void;
-    /**
-     * Create a serialized object of the current component.
-     */
-    toJSON(): SerializedDockview;
-    /**
-     * Reset the component back to an empty and default state.
-     */
-    clear(): void;
-    /**
-     * Move the focus progmatically to the next panel or group.
-     */
-    moveToNext(options?: MovementOptions): void;
-    /**
-     * Move the focus progmatically to the previous panel or group.
-     */
-    moveToPrevious(options?: MovementOptions): void;
-    maximizeGroup(panel: IDockviewPanel): void;
-    hasMaximizedGroup(): boolean;
-    exitMaximizedGroup(): void;
-    get onDidMaximizedGroupChange(): Event<DockviewMaximizedGroupChangeEvent>;
-    /**
-     * Add a popout group in a new Window
-     */
-    addPopoutGroup(item: IDockviewPanel | DockviewGroupPanel, options?: DockviewPopoutGroupOptions): Promise<boolean>;
-    /**
-     * Add an edge group at the given position. Returns the group panel API
-     * for the newly created group. Throws if a group already exists there.
-     */
-    addEdgeGroup(position: EdgeGroupPosition, options: EdgeGroupOptions): DockviewGroupPanelApi;
-    /**
-     * Get the group panel API for an edge group at the given position.
-     * Returns `undefined` if no edge group is configured at that position.
-     */
-    getEdgeGroup(position: EdgeGroupPosition): DockviewGroupPanelApi | undefined;
-    /**
-     * Set the visibility of an edge group.
-     */
-    setEdgeGroupVisible(position: EdgeGroupPosition, visible: boolean): void;
-    /**
-     * Check whether an edge group is currently visible.
-     */
-    isEdgeGroupVisible(position: EdgeGroupPosition): boolean;
-    /**
-     * Remove an edge group and reclaim its slot in the layout.
-     * All panels inside the group are disposed. Throws if no group exists at position.
-     */
-    removeEdgeGroup(position: EdgeGroupPosition): void;
-    updateOptions(options: Partial<DockviewComponentOptions>): void;
-    private _getGroupModel;
-    createTabGroup(options: {
-        groupId: string;
-        label?: string;
-        color?: string;
-        componentParams?: Record<string, unknown>;
-    }): ITabGroup;
-    dissolveTabGroup(options: {
-        groupId: string;
-        tabGroupId: string;
-    }): void;
-    addPanelToTabGroup(options: {
-        groupId: string;
-        tabGroupId: string;
-        panelId: string;
-        index?: number;
-    }): void;
-    removePanelFromTabGroup(options: {
-        groupId: string;
-        panelId: string;
-    }): void;
-    getTabGroups(options: DockviewGetTabGroupsOptions): readonly ITabGroup[];
-    getTabGroupForPanel(options: {
-        groupId: string;
-        panelId: string;
-    }): ITabGroup | undefined;
-    moveTabGroup(options: {
-        groupId: string;
-        tabGroupId: string;
-        index: number;
-    }): void;
-    /**
-     * Release resources and teardown component. Do not call when using framework versions of dockview.
-     */
-    dispose(): void;
-}