Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Interface IIgrDockManagerProps

Hierarchy

Hierarchy

  • IIgrDockManagerProps

Properties

Properties

Optional activePane

activePane?: IgrContentPane

Gets/sets the active pane of the Dock Manager.

Optional allowFloatingPanesResize

allowFloatingPanesResize?: string | boolean

Determines whether the end user is allowed to resize floating panes. Defaults to true.

Optional allowInnerDock

allowInnerDock?: string | boolean

Determines whether the end user is allowed to inner dock panes. Defaults to true.

Optional allowMaximize

allowMaximize?: string | boolean

Determines whether the end user is allowed to maximize panes. Defaults to true.

Optional allowSplitterDock

allowSplitterDock?: string | boolean

Determines whether the end user can dock the dragged pane directly in the parent split pane by dragging it over a splitter. If enabled, a docking indicator will be shown over the splitter's drag handler. Defaults to false.

Optional children

children?: ReactNode

Optional className

className?: string

Optional closeBehavior

closeBehavior?: string | PaneActionBehavior

Determines whether the selected pane or all panes are closed when clicking the close button of a pane within a dockable TabGroup. Defaults to 'allPanes'.

Optional containedInBoundaries

containedInBoundaries?: string | boolean

Determines whether the floating panes are kept inside the Dock Manager boundaries. Defaults to false.

Optional disableKeyboardNavigation

disableKeyboardNavigation?: string | boolean

Disables the built-in keyboard shortcuts for pane navigation. Defaults to false.

Optional draggedPane

draggedPane?: IgrDockManagerPane<IIgrDockManagerPaneProps>

Gets/sets the currently dragged pane.

Optional dropPosition

dropPosition?: IgrDockManagerPoint

Gets/sets the current drop position when performing custom drag/drop.

Optional id

id?: string

Optional layout

layout?: IgrDockManagerLayout

Gets/sets the layout configuration of the Dock Manager.

Optional layoutChange

layoutChange?: ((s, e) => void)

Type declaration

Optional maximizedPane

maximizedPane?: IgrDockManagerPane<IIgrDockManagerPaneProps>

Gets/sets the maximized pane.

Optional proximityDock

proximityDock?: string | boolean

Determines whether the end user can dock the dragged pane by dragging it close to the target pane edges. If enabled, docking indicators are not visible. Defaults to false.

Optional resourceStrings

resourceStrings?: IgrDockManagerResourceStrings

Gets/sets the resource strings.

Optional showHeaderIconOnHover

showHeaderIconOnHover?: string | DockManagerShowHeaderIconOnHover

Determines which tab header icons should show when hovering over the tab with the mouse. Defaults to none.

Optional showPaneHeaders

showPaneHeaders?: string | DockManagerShowPaneHeaders

Determines whether pane headers are only shown on hover or always visible. Defaults to 'always'.

Optional style

style?: CSSProperties

Optional unpinBehavior

unpinBehavior?: string | PaneActionBehavior

Determines whether the selected pane or all panes are unpinned when clicking the unpin button of a pane within a dockable TabGroup. Defaults to 'allPanes'.