flexlayout-react
    Preparing search index...

    Interface ITabAttributes

    interface ITabAttributes {
        altName?: string;
        borderHeight?: number;
        borderWidth?: number;
        className?: string;
        closeType?: ICloseType;
        component?: string;
        config?: any;
        contentClassName?: string;
        enableClose?: boolean;
        enableDrag?: boolean;
        enablePin?: boolean;
        enablePopout?: boolean;
        enablePopoutFloatIcon?: boolean;
        enablePopoutIcon?: boolean;
        enablePopoutOverlay?: boolean;
        enableRename?: boolean;
        enableRenderOnDemand?: boolean;
        enableScrollbars?: boolean;
        enableWindowReMount?: boolean;
        helpText?: string;
        icon?: string;
        id?: string;
        maxHeight?: number;
        maxWidth?: number;
        minHeight?: number;
        minWidth?: number;
        name?: string;
        pinned?: boolean;
        subLayoutId?: string;
        tabsetClassName?: string;
        type?: string;
    }
    Index
    altName? borderHeight? borderWidth? className? closeType? component? config? contentClassName? enableClose? enableDrag? enablePin? enablePopout? enablePopoutFloatIcon? enablePopoutIcon? enablePopoutOverlay? enableRename? enableRenderOnDemand? enableScrollbars? enableWindowReMount? helpText? icon? id? maxHeight? maxWidth? minHeight? minWidth? name? pinned? subLayoutId? tabsetClassName? type?
    altName?: string

    the name used in the overflow menu when the tab has no name (e.g. an icon-only tab)

    Default: undefined

    borderHeight?: number

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

    Default: inherited from Global attribute tabBorderHeight (default -1)

    borderWidth?: number

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

    Default: inherited from Global attribute tabBorderWidth (default -1)

    className?: string

    class applied to tab button

    Default: inherited from Global attribute tabClassName (default undefined)

    closeType?: ICloseType

    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: inherited from Global attribute tabCloseType (default 1)

    component?: string

    string identifying which component to render in this tab (used in the layout factory function)

    Default: undefined

    config?: any

    a place to hold json config for the hosted component

    Default: undefined

    contentClassName?: string

    class applied to tab content

    Default: inherited from Global attribute tabContentClassName (default undefined)

    enableClose?: boolean

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

    Default: inherited from Global attribute tabEnableClose (default true)

    enableDrag?: boolean

    whether the user can drag the tab to a new location

    Default: inherited from Global attribute tabEnableDrag (default true)

    enablePin?: boolean

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

    Default: inherited from Global attribute tabEnablePin (default true)

    enablePopout?: boolean

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

    Default: inherited from Global attribute tabEnablePopout (default false)

    enablePopoutFloatIcon?: boolean

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

    Default: inherited from Global attribute tabEnablePopoutFloatIcon (default false)

    enablePopoutIcon?: boolean

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

    Default: inherited from Global attribute tabEnablePopoutIcon (default true)

    enablePopoutOverlay?: boolean

    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: inherited from Global attribute tabEnablePopoutOverlay (default false)

    enableRename?: boolean

    whether the user can rename the tab by double clicking

    Default: inherited from Global attribute tabEnableRename (default true)

    enableRenderOnDemand?: boolean

    whether to avoid rendering component until tab is visible

    Default: inherited from Global attribute tabEnableRenderOnDemand (default true)

    enableScrollbars?: boolean

    whether the tab will be hosted in a scrollable container

    Default: inherited from Global attribute tabEnableScrollbars (default true)

    enableWindowReMount?: boolean

    if enabled the tab will re-mount when popped out/in

    Default: false

    helpText?: string

    help text for the tab to be displayed upon tab hover

    Default: undefined

    icon?: string

    the tab icon

    Default: inherited from Global attribute tabIcon (default undefined)

    id?: string

    the unique id of the tab, if left undefined a uuid will be assigned

    Default: undefined

    maxHeight?: number

    the maximum height (in px) of this tab

    Default: inherited from Global attribute tabMaxHeight (default 99999)

    maxWidth?: number

    the maximum width (in px) of this tab

    Default: inherited from Global attribute tabMaxWidth (default 99999)

    minHeight?: number

    the minimum height (in px) of this tab

    Default: inherited from Global attribute tabMinHeight (default 1)

    minWidth?: number

    the minimum width (in px) of this tab

    Default: inherited from Global attribute tabMinWidth (default 1)

    name?: string

    name of tab to be displayed in the tab button

    Default: "[Unnamed Tab]"

    pinned?: boolean

    whether the tab is pinned; pinned tabs are grouped at the start of the tabstrip, cannot be closed via the ui, and cannot be dragged out of their tabset (they can be reordered within the pinned group). Set via Actions.setTabPinned. Only applies to tabs in tabsets (not borders); pinned tabs should be listed first in the json

    Default: false

    subLayoutId?: string

    the Id of the sub layout to render in this tab, defined in the subLayouts section of the model json (if component is also defined then use the component in the factory to render the sublayout)

    Default: undefined

    tabsetClassName?: string

    class applied to parent tabset when this is the only tab and it is stretched to fill the tabset

    Default: undefined

    type?: string

    Fixed value: "tab"

    Settings
    Member Visibility

    On This Page
    Properties