Interface IDockviewReactProps

interface IDockviewReactProps {
    components: Record<string, FunctionComponent<IDockviewPanelProps>>;
    defaultTabComponent?: FunctionComponent<IDockviewPanelHeaderProps>;
    getTabContextMenuItems?: ((params) => (ReactContextMenuItemConfig | BuiltInContextMenuItem)[]);
    leftHeaderActionsComponent?: FunctionComponent<IDockviewHeaderActionsProps>;
    onDidDrop?: ((event) => void);
    onReady: ((event) => void);
    onWillDrop?: ((event) => void);
    prefixHeaderActionsComponent?: FunctionComponent<IDockviewHeaderActionsProps>;
    rightHeaderActionsComponent?: FunctionComponent<IDockviewHeaderActionsProps>;
    tabComponents?: Record<string, FunctionComponent<IDockviewPanelHeaderProps>>;
    watermarkComponent?: FunctionComponent<IWatermarkPanelProps>;
}

Hierarchy (view full)

Properties

components defaultTabComponent? getTabContextMenuItems? leftHeaderActionsComponent? onDidDrop? onReady onWillDrop? prefixHeaderActionsComponent? rightHeaderActionsComponent? tabComponents? watermarkComponent?

Properties

components

components: Record<string, FunctionComponent<IDockviewPanelProps>>

Optional defaultTabComponent

defaultTabComponent?: FunctionComponent<IDockviewPanelHeaderProps>

Optional getTabContextMenuItems

getTabContextMenuItems?: ((params) => (ReactContextMenuItemConfig | BuiltInContextMenuItem)[])

Return the items to display in the tab context menu on right-click.

Use built-in string shortcuts ('close', 'closeOthers', 'closeAll', 'separator') or provide a ContextMenuItemConfig object for custom items.

If omitted, no context menu is shown. Return an empty array to suppress the menu for specific cases.

Type declaration

Optional leftHeaderActionsComponent

leftHeaderActionsComponent?: FunctionComponent<IDockviewHeaderActionsProps>

Optional onDidDrop

onDidDrop?: ((event) => void)

Type declaration

onReady

onReady: ((event) => void)

Type declaration

Optional onWillDrop

onWillDrop?: ((event) => void)

Type declaration

Optional prefixHeaderActionsComponent

prefixHeaderActionsComponent?: FunctionComponent<IDockviewHeaderActionsProps>

Optional rightHeaderActionsComponent

rightHeaderActionsComponent?: FunctionComponent<IDockviewHeaderActionsProps>

Optional tabComponents

tabComponents?: Record<string, FunctionComponent<IDockviewPanelHeaderProps>>

Optional watermarkComponent

watermarkComponent?: FunctionComponent<IWatermarkPanelProps>

Settings

Member Visibility

Theme

On This Page

componentsdefaultTabComponentgetTabContextMenuItemsleftHeaderActionsComponentonDidDroponReadyonWillDropprefixHeaderActionsComponentrightHeaderActionsComponenttabComponentswatermarkComponent