Skip to main content

Tab

Tab Widget API

Properties​

TabBar​

WidgetHasChildrenHasState
</>
Tab.TabBar: Iris.TabBar

Creates a TabBar for putting tabs under. This does not create the tabs but just the container for them to be in. The index state is used to control the current tab and is based on an index starting from 1 rather than the text provided to a Tab. The TabBar will replicate the index to the Tab children . 

hasChildren: true
hasState: true
Arguments = {}
Events = {}
State = {
    index: State<number>? -- whether the widget is collapsed.
}

Tab​

WidgetHasChildrenHasState
</>
Tab.Tab: Iris.Tab

The tab item for use under a TabBar. The TabBar must be the parent and determines the index value. You cannot provide a state for this tab. The optional Hideable argument determines if a tab can be closed, which is controlled by the isOpened state.

A tab will take up the full horizontal width of the parent and hide any other tabs in the TabBar.

hasChildren: true
hasState: true
Arguments = {
    Text: string,
    Hideable: boolean? = nil -- determines whether a tab can be closed/hidden
}
Events = {
    clicked: () -> boolean,
    hovered: () -> boolean
    selected: () -> boolean
    unselected: () -> boolean
    active: () -> boolean
    opened: () -> boolean
    closed: () -> boolean
}
State = {
    isOpened: State<boolean>?
}
Show raw api
{
    "functions": [],
    "properties": [
        {
            "name": "TabBar",
            "desc": "Creates a TabBar for putting tabs under. This does not create the tabs but just the container for them to be in.\nThe index state is used to control the current tab and is based on an index starting from 1 rather than the\ntext provided to a Tab. The TabBar will replicate the index to the Tab children .\n\n```lua\nhasChildren: true\nhasState: true\nArguments = {}\nEvents = {}\nState = {\n    index: State<number>? -- whether the widget is collapsed.\n}\n```\n    ",
            "lua_type": "Iris.TabBar",
            "tags": [
                "Widget",
                "HasChildren",
                "HasState"
            ],
            "source": {
                "line": 823,
                "path": "lib/API.lua"
            }
        },
        {
            "name": "Tab",
            "desc": "The tab item for use under a TabBar. The TabBar must be the parent and determines the index value. You cannot\nprovide a state for this tab. The optional Hideable argument determines if a tab can be closed, which is\ncontrolled by the isOpened state.\n\nA tab will take up the full horizontal width of the parent and hide any other tabs in the TabBar.\n\n```lua\nhasChildren: true\nhasState: true\nArguments = {\n    Text: string,\n    Hideable: boolean? = nil -- determines whether a tab can be closed/hidden\n}\nEvents = {\n    clicked: () -> boolean,\n    hovered: () -> boolean\n    selected: () -> boolean\n    unselected: () -> boolean\n    active: () -> boolean\n    opened: () -> boolean\n    closed: () -> boolean\n}\nState = {\n    isOpened: State<boolean>?\n}\n```\n    ",
            "lua_type": "Iris.Tab",
            "tags": [
                "Widget",
                "HasChildren",
                "HasState"
            ],
            "source": {
                "line": 859,
                "path": "lib/API.lua"
            }
        }
    ],
    "types": [],
    "name": "Tab",
    "desc": "Tab Widget API\n    ",
    "source": {
        "line": 801,
        "path": "lib/API.lua"
    }
}