Type alias AddPanelOptions<P>

AddPanelOptions<P>: {
    component: string;
    id: string;
    inactive?: boolean;
    initialHeight?: number;
    initialWidth?: number;
    params?: P;
    renderer?: DockviewPanelRenderer;
    tabComponent?: string;
    title?: string;
} & Partial<AddPanelOptionsUnion> & Partial<Contraints>

Type Parameters

Type declaration

  • component: string

    The id of the component renderer

  • id: string

    The unique id for the panel

  • Optional inactive?: boolean

    If true then add the panel without setting it as the active panel.

    Defaults to false which forces newly added panels to become active.

  • Optional initialHeight?: number
  • Optional initialWidth?: number
  • Optional params?: P
  • Optional renderer?: DockviewPanelRenderer

    The rendering mode of the panel.

    This dictates what happens to the HTML of the panel when it is hidden.

  • Optional tabComponent?: string

    The id of the tab componnet renderer

  • Optional title?: string

    The title for the panel which can be accessed within both the tab and component.

    If using the default tab renderer this title will be displayed in the tab.

Settings

Member Visibility

Theme

Generated using TypeDoc