Type alias LayoutOptions

Type declaration

• Optional content?: LayoutContent

• Optional dimensions?: {
      borderWidth?: number;
      headerHeight?: number;
      minItemHeight?: number;
      minItemWidth?: number;
  }

  • Optional borderWidth?: number

  • Optional headerHeight?: number

  • Optional minItemHeight?: number

  • Optional minItemWidth?: number

• Optional settings?: {
      constrainDragToContainer?: boolean;
      constrainDragToHeaders?: boolean;
      hasHeaders?: boolean;
      popoutWholeStack?: boolean;
      preventDragIn?: boolean;
      preventDragOut?: boolean;
      reorderEnabled?: boolean;
      showCloseIcon?: boolean;
      showMaximiseIcon?: boolean;
      showPopoutIcon?: boolean;
  }

  Represents a potential ways to customize behavior of your Layout

  • Optional constrainDragToContainer?: boolean

    Default Value

    false

    Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.

  • Optional constrainDragToHeaders?: boolean

  • Optional hasHeaders?: boolean

    Default Value

    true

    Turns tab headers on or off. If false, the layout will be displayed with splitters only.

  • Optional popoutWholeStack?: boolean

    Default Value

    false

    Whether the popout button will only act on the entire stack, as opposed to only the active tab.

  • Optional preventDragIn?: boolean

    @defaultValue=false

    If true, tabs can't be dragged into the window.

  • Optional preventDragOut?: boolean

    Default Value

    false

    If true, tabs can't be dragged out of the window.

  • Optional reorderEnabled?: boolean

    Default Value

    true

    If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.

  • Optional showCloseIcon?: boolean

    Default Value

    false

    Whether to show the close button on stack header (not to be confused with close button on every tab).

  • Optional showMaximiseIcon?: boolean

    Default Value

    false

    Whether to show the maximize button on stack header. The button will maximize the current tab to fill the entire window.

  • Optional showPopoutIcon?: boolean

    Default Value

    false

    Whether to show the popout button on stack header. The button will create a new window with current tab as its content. In case popoutWholeStack is set to true, all tabs in the stack will be in the new window.