Interface IDockviewReactProps

interface IDockviewReactProps {
    className?: string;
    components: Record<string, FunctionComponent<IDockviewPanelProps>>;
    defaultTabComponent?: FunctionComponent<IDockviewPanelHeaderProps>;
    leftHeaderActionsComponent?: FunctionComponent<IDockviewHeaderActionsProps>;
    onDidDrop?: ((event) => void);
    onReady: ((event) => void);
    onWillDrop?: ((event) => void);
    prefixHeaderActionsComponent?: FunctionComponent<IDockviewHeaderActionsProps>;
    rightHeaderActionsComponent?: FunctionComponent<IDockviewHeaderActionsProps>;
    showDndOverlay?: ((event) => boolean);
    tabComponents?: Record<string, FunctionComponent<IDockviewPanelHeaderProps>>;
    watermarkComponent?: FunctionComponent<IWatermarkPanelProps>;
}

Hierarchy (view full)

DockviewOptions
- IDockviewReactProps

Index

Properties

className? components defaultTabComponent? leftHeaderActionsComponent? onDidDrop? onReady onWillDrop? prefixHeaderActionsComponent? rightHeaderActionsComponent? showDndOverlay? tabComponents? watermarkComponent?

Properties

`Optional` className

className?: string

components

components: Record<string, FunctionComponent<IDockviewPanelProps>>

`Optional` defaultTabComponent

defaultTabComponent?: FunctionComponent<IDockviewPanelHeaderProps>

`Optional` leftHeaderActionsComponent

leftHeaderActionsComponent?: FunctionComponent<IDockviewHeaderActionsProps>

`Optional` onDidDrop

onDidDrop?: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: DockviewDidDropEvent
  Returns void

onReady

onReady: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: DockviewReadyEvent
  Returns void

`Optional` onWillDrop

onWillDrop?: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: DockviewWillDropEvent
  Returns void

`Optional` prefixHeaderActionsComponent

prefixHeaderActionsComponent?: FunctionComponent<IDockviewHeaderActionsProps>

`Optional` rightHeaderActionsComponent

rightHeaderActionsComponent?: FunctionComponent<IDockviewHeaderActionsProps>

`Optional` showDndOverlay

showDndOverlay?: ((event) => boolean)

Type declaration

- (event): boolean
- Parameters
  - event: DockviewDndOverlayEvent
  Returns boolean
  Deprecated
  use api.onUnhandledDragOverEvent instead. This will be removed in the next release.

Deprecated

use api.onUnhandledDragOverEvent instead. This will be removed in the next release.

`Optional` tabComponents

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

`Optional` watermarkComponent

watermarkComponent?: FunctionComponent<IWatermarkPanelProps>

Generated using TypeDoc