flexlayout-react
    Preparing search index...

    Interface IGlobalAttributes

    interface IGlobalAttributes {
        borderAutoSelectTabWhenClosed?: boolean;
        borderAutoSelectTabWhenOpen?: boolean;
        borderClassName?: string;
        borderEnableAutoHide?: boolean;
        borderEnableDrop?: boolean;
        borderEnableTabScrollbar?: boolean;
        borderLeftTabDirection?: IBorderTabDirection;
        borderMaxSize?: number;
        borderMinSize?: number;
        borderSize?: number;
        enableEdgeDock?: boolean;
        enableEdgeDockIndicators?: boolean;
        enableRotateBorderIcons?: boolean;
        rootOrientationVertical?: boolean;
        tabBorderHeight?: number;
        tabBorderWidth?: number;
        tabClassName?: string;
        tabCloseType?: ICloseType;
        tabContentClassName?: string;
        tabEnableClose?: boolean;
        tabEnableDrag?: boolean;
        tabEnablePin?: boolean;
        tabEnablePopout?: boolean;
        tabEnablePopoutFloatIcon?: boolean;
        tabEnablePopoutIcon?: boolean;
        tabEnablePopoutOverlay?: boolean;
        tabEnableRename?: boolean;
        tabEnableRenderOnDemand?: boolean;
        tabEnableScrollbars?: boolean;
        tabGroupType?: ITabGroupType;
        tabIcon?: string;
        tabMaxHeight?: number;
        tabMaxWidth?: number;
        tabMinHeight?: number;
        tabMinWidth?: number;
        tabSetAutoSelectTab?: boolean;
        tabSetClassNameTabStrip?: string;
        tabSetEnableActiveIcon?: boolean;
        tabSetEnableClose?: boolean;
        tabSetEnableCloseButton?: boolean;
        tabSetEnableDeleteWhenEmpty?: boolean;
        tabSetEnableDivide?: boolean;
        tabSetEnableDrag?: boolean;
        tabSetEnableDrop?: boolean;
        tabSetEnableMaximize?: boolean;
        tabSetEnableSingleTabStretch?: boolean;
        tabSetEnableTabScrollbar?: boolean;
        tabSetEnableTabStrip?: boolean;
        tabSetEnableTabWrap?: boolean;
        tabSetMaxHeight?: number;
        tabSetMaxWidth?: number;
        tabSetMinHeight?: number;
        tabSetMinWidth?: number;
        tabSetTabLocation?: ITabLocation;
    }
    Index
    borderAutoSelectTabWhenClosed? borderAutoSelectTabWhenOpen? borderClassName? borderEnableAutoHide? borderEnableDrop? borderEnableTabScrollbar? borderLeftTabDirection? borderMaxSize? borderMinSize? borderSize? enableEdgeDock? enableEdgeDockIndicators? enableRotateBorderIcons? rootOrientationVertical? tabBorderHeight? tabBorderWidth? tabClassName? tabCloseType? tabContentClassName? tabEnableClose? tabEnableDrag? tabEnablePin? tabEnablePopout? tabEnablePopoutFloatIcon? tabEnablePopoutIcon? tabEnablePopoutOverlay? tabEnableRename? tabEnableRenderOnDemand? tabEnableScrollbars? tabGroupType? tabIcon? tabMaxHeight? tabMaxWidth? tabMinHeight? tabMinWidth? tabSetAutoSelectTab? tabSetClassNameTabStrip? tabSetEnableActiveIcon? tabSetEnableClose? tabSetEnableCloseButton? tabSetEnableDeleteWhenEmpty? tabSetEnableDivide? tabSetEnableDrag? tabSetEnableDrop? tabSetEnableMaximize? tabSetEnableSingleTabStretch? tabSetEnableTabScrollbar? tabSetEnableTabStrip? tabSetEnableTabWrap? tabSetMaxHeight? tabSetMaxWidth? tabSetMinHeight? tabSetMinWidth? tabSetTabLocation?
    borderAutoSelectTabWhenClosed?: boolean

    Value for BorderNode attribute autoSelectTabWhenClosed if not overridden

    whether to select new/moved tabs in border when the border is currently closed

    Default: false

    borderAutoSelectTabWhenOpen?: boolean

    Value for BorderNode attribute autoSelectTabWhenOpen if not overridden

    whether to select new/moved tabs in border when the border is already open

    Default: true

    borderClassName?: string

    Value for BorderNode attribute className if not overridden

    class applied to the border container

    Default: undefined

    borderEnableAutoHide?: boolean

    Value for BorderNode attribute enableAutoHide if not overridden

    hide border if it has zero tabs; not related to the borderType 'overlay' mode (Visual Studio style auto hide), see the borderType attribute

    Default: false

    borderEnableDrop?: boolean

    Value for BorderNode attribute enableDrop if not overridden

    whether tabs can be dropped into this border

    Default: true

    borderEnableTabScrollbar?: boolean

    Value for BorderNode attribute enableTabScrollbar if not overridden

    whether to show a mini scrollbar for the tabs

    Default: false

    borderLeftTabDirection?: IBorderTabDirection

    the direction the left border tabs read: 'up' (default, text reads bottom to top) or 'down' (text reads top to bottom like the right border)

    Default: "up"

    borderMaxSize?: number

    Value for BorderNode attribute maxSize if not overridden

    the maximum size of the tab area

    Default: 99999

    borderMinSize?: number

    Value for BorderNode attribute minSize if not overridden

    the minimum size of the tab area

    Default: 1

    borderSize?: number

    Value for BorderNode attribute size if not overridden

    size of the tab area when selected

    Default: 200

    enableEdgeDock?: boolean

    enable docking to the edges of the layout

    Default: true

    enableEdgeDockIndicators?: boolean

    show the edge indicators when dragging

    Default: true

    enableRotateBorderIcons?: boolean

    boolean indicating if tab icons should rotate with the text in the left and right borders

    Default: true

    rootOrientationVertical?: boolean

    the top level 'row' will layout horizontally by default, set this option true to make it layout vertically

    Default: false

    tabBorderHeight?: number

    Value for TabNode attribute borderHeight if not overridden

    the height of this tab when shown in a border; -1 uses the border's default size

    Default: -1

    tabBorderWidth?: number

    Value for TabNode attribute borderWidth if not overridden

    the width of this tab when shown in a border; -1 uses the border's default size

    Default: -1

    tabClassName?: string

    Value for TabNode attribute className if not overridden

    class applied to tab button

    Default: undefined

    tabCloseType?: ICloseType

    Value for TabNode attribute closeType if not overridden

    when the tab's close button is active: Visible (default) active if selected or hovered (note: mobile doesnt support hovered), Always: always active, Selected only active on selected tab (clicking on the x button on a non-selected tab will just select it)

    Default: 1

    tabContentClassName?: string

    Value for TabNode attribute contentClassName if not overridden

    class applied to tab content

    Default: undefined

    tabEnableClose?: boolean

    Value for TabNode attribute enableClose if not overridden

    whether the tab can be closed by the user via its close button

    Default: true

    tabEnableDrag?: boolean

    Value for TabNode attribute enableDrag if not overridden

    whether the user can drag the tab to a new location

    Default: true

    tabEnablePin?: boolean

    Value for TabNode attribute enablePin if not overridden

    whether the user can pin/unpin the tab via the context menu

    Default: true

    tabEnablePopout?: boolean

    Value for TabNode attribute enablePopout if not overridden

    enable window popout (in popout capable browser), to show an icon in the tabset header also set the enablePopoutIcon attribute

    Default: false

    tabEnablePopoutFloatIcon?: boolean

    Value for TabNode attribute enablePopoutFloatIcon if not overridden

    whether to show the popout float icon in the tabset header if this tab enables floating popouts

    Default: false

    tabEnablePopoutIcon?: boolean

    Value for TabNode attribute enablePopoutIcon if not overridden

    whether to show the popout icon in the tabset header if this tab enables popouts

    Default: true

    tabEnablePopoutOverlay?: boolean

    Value for TabNode attribute enablePopoutOverlay if not overridden

    if this tab will not work correctly in a popout window when the main window is backgrounded (inactive) then enabling this option will gray out this tab

    Default: false

    tabEnableRename?: boolean

    Value for TabNode attribute enableRename if not overridden

    whether the user can rename the tab by double clicking

    Default: true

    tabEnableRenderOnDemand?: boolean

    Value for TabNode attribute enableRenderOnDemand if not overridden

    whether to avoid rendering component until tab is visible

    Default: true

    tabEnableScrollbars?: boolean

    Value for TabNode attribute enableScrollbars if not overridden

    whether the tab will be hosted in a scrollable container

    Default: true

    tabGroupType?: ITabGroupType

    how a tab group is visually indicated: 'splitpill' encloses the group's tabs in a pill (left/right caps), 'underline' draws a colored underline under each grouped tab

    Default: "splitpill"

    tabIcon?: string

    Value for TabNode attribute icon if not overridden

    the tab icon

    Default: undefined

    tabMaxHeight?: number

    Value for TabNode attribute maxHeight if not overridden

    the maximum height (in px) of this tab

    Default: 99999

    tabMaxWidth?: number

    Value for TabNode attribute maxWidth if not overridden

    the maximum width (in px) of this tab

    Default: 99999

    tabMinHeight?: number

    Value for TabNode attribute minHeight if not overridden

    the minimum height (in px) of this tab

    Default: 1

    tabMinWidth?: number

    Value for TabNode attribute minWidth if not overridden

    the minimum width (in px) of this tab

    Default: 1

    tabSetAutoSelectTab?: boolean

    Value for TabSetNode attribute autoSelectTab if not overridden

    whether to select new/moved tabs in tabset

    Default: true

    tabSetClassNameTabStrip?: string

    Value for TabSetNode attribute classNameTabStrip if not overridden

    a class name to apply to the tab strip

    Default: undefined

    tabSetEnableActiveIcon?: boolean

    Value for TabSetNode attribute enableActiveIcon if not overridden

    whether the active icon (*) should be displayed when the tabset is active

    Default: false

    tabSetEnableClose?: boolean

    Value for TabSetNode attribute enableClose if not overridden

    whether this tabset can be closed

    Default: true

    tabSetEnableCloseButton?: boolean

    Value for TabSetNode attribute enableCloseButton if not overridden

    if the tabset can be closed then show a close button

    Default: false

    tabSetEnableDeleteWhenEmpty?: boolean

    Value for TabSetNode attribute enableDeleteWhenEmpty if not overridden

    whether to delete this tabset when it has no tabs

    Default: true

    tabSetEnableDivide?: boolean

    Value for TabSetNode attribute enableDivide if not overridden

    whether dropping on an edge of this tabset splits it to create a new tabset

    Default: true

    tabSetEnableDrag?: boolean

    Value for TabSetNode attribute enableDrag if not overridden

    whether the user can drag tabs out of this tabset

    Default: true

    tabSetEnableDrop?: boolean

    Value for TabSetNode attribute enableDrop if not overridden

    whether tabs can be dropped into this tabset

    Default: true

    tabSetEnableMaximize?: boolean

    Value for TabSetNode attribute enableMaximize if not overridden

    whether the tabset can be maximized to fill the layout via the maximize button

    Default: true

    tabSetEnableSingleTabStretch?: boolean

    Value for TabSetNode attribute enableSingleTabStretch if not overridden

    if the tabset has only a single tab then stretch the single tab to fill area and display in a header style

    Default: false

    tabSetEnableTabScrollbar?: boolean

    Value for TabSetNode attribute enableTabScrollbar if not overridden

    whether to show a mini scrollbar for the tabs

    Default: false

    tabSetEnableTabStrip?: boolean

    Value for TabSetNode attribute enableTabStrip if not overridden

    when enabled the tabset shows a tab strip and can host multiple tabs; when disabled the strip is hidden

    Default: true

    tabSetEnableTabWrap?: boolean

    Value for TabSetNode attribute enableTabWrap if not overridden

    wrap tabs onto multiple lines

    Default: false

    tabSetMaxHeight?: number

    Value for TabSetNode attribute maxHeight if not overridden

    maximum height (in px) for this tabset

    Default: 99999

    tabSetMaxWidth?: number

    Value for TabSetNode attribute maxWidth if not overridden

    maximum width (in px) for this tabset

    Default: 99999

    tabSetMinHeight?: number

    Value for TabSetNode attribute minHeight if not overridden

    minimum height (in px) for this tabset

    Default: 1

    tabSetMinWidth?: number

    Value for TabSetNode attribute minWidth if not overridden

    minimum width (in px) for this tabset

    Default: 1

    tabSetTabLocation?: ITabLocation

    Value for TabSetNode attribute tabLocation if not overridden

    the location of the tabs either top or bottom

    Default: "top"

    Settings
    Member Visibility

    On This Page
    Properties
    borderAutoSelectTabWhenClosedborderAutoSelectTabWhenOpenborderClassNameborderEnableAutoHideborderEnableDropborderEnableTabScrollbarborderLeftTabDirectionborderMaxSizeborderMinSizeborderSizeenableEdgeDockenableEdgeDockIndicatorsenableRotateBorderIconsrootOrientationVerticaltabBorderHeighttabBorderWidthtabClassNametabCloseTypetabContentClassNametabEnableClosetabEnableDragtabEnablePintabEnablePopouttabEnablePopoutFloatIcontabEnablePopoutIcontabEnablePopoutOverlaytabEnableRenametabEnableRenderOnDemandtabEnableScrollbarstabGroupTypetabIcontabMaxHeighttabMaxWidthtabMinHeighttabMinWidthtabSetAutoSelectTabtabSetClassNameTabStriptabSetEnableActiveIcontabSetEnableClosetabSetEnableCloseButtontabSetEnableDeleteWhenEmptytabSetEnableDividetabSetEnableDragtabSetEnableDroptabSetEnableMaximizetabSetEnableSingleTabStretchtabSetEnableTabScrollbartabSetEnableTabStriptabSetEnableTabWraptabSetMaxHeighttabSetMaxWidthtabSetMinHeighttabSetMinWidthtabSetTabLocation