Describes a Dock Manager component.

Hierarchy

  • HTMLElement
    • IgcDockManagerComponent

Index

Constructors

  • Returns IgcDockManagerComponent

Properties

activePane: IgcContentPane

Gets/sets the active pane of the Dock Manager.

allowFloatingPanesResize: boolean

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

allowInnerDock?: boolean

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

allowMaximize: boolean

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

closeBehavior: IgcPaneActionBehavior

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'.

containedInBoundaries: boolean

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

disableKeyboardNavigation: boolean

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

Gets/sets the currently dragged pane.

dropPosition: IgcDockManagerPoint

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

Gets/sets the layout configuration of the Dock Manager.

Gets/sets the maximized pane.

proximityDock?: 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.

Gets/sets the resource strings.

showHeaderIconOnHover: "closeOnly" | "moreOptionsOnly" | "all"

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

showPaneHeaders: "onHoverOnly" | "always"

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

unpinBehavior: IgcPaneActionBehavior

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'.

Methods

  • addEventListener<K>(type: K, listener: ((this: HTMLElement, ev: IgcDockManagerEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void
  • addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
  • dropPane(): Promise<boolean>
  • focusPane(contentId: string): Promise<void>
  • removeEventListener<K>(type: K, listener: ((this: HTMLElement, ev: IgcDockManagerEventMap[K]) => any), options?: boolean | EventListenerOptions): void
  • removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void