@aptre/flex-layout
    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;
        enableRename?: boolean;
        enableRenderOnDemand?: boolean;
        helpText?: string;
        icon?: string;
        id?: string;
        maxHeight?: number;
        maxWidth?: number;
        minHeight?: number;
        minWidth?: number;
        name?: string;
        tabsetClassName?: string;
        type: "tab";
    }

    Hierarchy (View Summary)

    Index

    Properties

    altName? borderHeight? borderWidth? className? closeType? component? config? contentClassName? enableClose? enableDrag? enableRename? enableRenderOnDemand? helpText? icon? id? maxHeight? maxWidth? minHeight? minWidth? name? tabsetClassName? type

    Properties

    altName?: string

    if there is no name specifed then this value will be used in the overflow menu

    Default: undefined

    borderHeight?: number

    height when added to border, -1 will use border size

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

    borderWidth?: number

    width when added to border, -1 will use border 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

    see values in ICloseType

    Default: inherited from Global attribute tabCloseType (default 1)

    component?: string

    string identifying which component to run (for factory)

    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

    allow user to close tab via close button

    Default: inherited from Global attribute tabEnableClose (default true)

    enableDrag?: boolean

    allow user to drag tab to new location

    Default: inherited from Global attribute tabEnableDrag (default true)

    enableRename?: boolean

    allow user to rename tabs 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)

    helpText?: string

    An optional 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 max height of this tab

    Default: inherited from Global attribute tabMaxHeight (default 99999)

    maxWidth?: number

    the max width of this tab

    Default: inherited from Global attribute tabMaxWidth (default 99999)

    minHeight?: number

    the min height of this tab

    Default: inherited from Global attribute tabMinHeight (default 0)

    minWidth?: number

    the min width of this tab

    Default: inherited from Global attribute tabMinWidth (default 0)

    name?: string

    name of tab to be displayed in the tab button

    Default: "[Unnamed Tab]"

    tabsetClassName?: string

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

    Default: undefined

    type: "tab"

    The type of this node (always "tab")

    Settings

    Member Visibility

    On This Page

    Properties