Skip to main content

Combo

Combo Widget API

Properties​

Selectable​

WidgetHasState
</>
Combo.Selectable: Iris.Selectable

An object which can be selected.

hasChildren = false
hasState = true
Arguments = {
    Text: string,
    Index: any, -- index of selectable value.
    NoClick: boolean? = false -- prevents the selectable from being clicked by the user.
}
Events = {
    selected: () -> boolean,
    unselected: () -> boolean,
    active: () -> boolean,
    clicked: () -> boolean,
    rightClicked: () -> boolean,
    doubleClicked: () -> boolean,
    ctrlClicked: () -> boolean,
    hovered: () -> boolean,
}
States = {
    index: State<any> -- a shared state between all selectables.
}

Combo​

WidgetHasChildrenHasState
</>
Combo.Combo: Iris.Combo

A selection box to choose a value from a range of values.

hasChildren = true
hasState = true
Arguments = {
    Text: string,
    NoButton: boolean? = false, -- hide the dropdown button.
    NoPreview: boolean? = false -- hide the preview field.
}
Events = {
    opened: () -> boolean,
    closed: () -> boolean,
    clicked: () -> boolean,
    hovered: () -> boolean
}
States = {
    index: State<any>,
    isOpened: State<boolean>?
}

ComboArray​

WidgetHasChildrenHasState
</>
Combo.ComboArray: Iris.Combo

A selection box to choose a value from an array.

hasChildren = true
hasState = true
Arguments = {
    Text: string,
    NoButton: boolean? = false, -- hide the dropdown button.
    NoPreview: boolean? = false -- hide the preview field.
}
Events = {
    opened: () -> boolean,
    closed: () -> boolean,
    clicked: () -> boolean,
    hovered: () -> boolean
}
States = {
    index: State<any>,
    isOpened: State<boolean>?
}
Extra = {
    selectionArray: { any } -- the array to generate a combo from.
}

ComboEnum​

WidgetHasChildrenHasState
</>
Combo.ComboEnum: Iris.Combo

A selection box to choose a value from an Enum.

hasChildren = true
hasState = true
Arguments = {
    Text: string,
    NoButton: boolean? = false, -- hide the dropdown button.
    NoPreview: boolean? = false -- hide the preview field.
}
Events = {
    opened: () -> boolean,
    closed: () -> boolean,
    clicked: () -> boolean,
    hovered: () -> boolean
}
States = {
    index: State<any>,
    isOpened: State<boolean>?
}
Extra = {
    enumType: Enum -- the enum to generate a combo from.
}
Show raw api
{
    "functions": [],
    "properties": [
        {
            "name": "Selectable",
            "desc": "An object which can be selected.\n\n```lua\nhasChildren = false\nhasState = true\nArguments = {\n    Text: string,\n    Index: any, -- index of selectable value.\n    NoClick: boolean? = false -- prevents the selectable from being clicked by the user.\n}\nEvents = {\n    selected: () -> boolean,\n    unselected: () -> boolean,\n    active: () -> boolean,\n    clicked: () -> boolean,\n    rightClicked: () -> boolean,\n    doubleClicked: () -> boolean,\n    ctrlClicked: () -> boolean,\n    hovered: () -> boolean,\n}\nStates = {\n    index: State<any> -- a shared state between all selectables.\n}\n```\n    ",
            "lua_type": "Iris.Selectable",
            "tags": [
                "Widget",
                "HasState"
            ],
            "source": {
                "line": 1436,
                "path": "lib/API.lua"
            }
        },
        {
            "name": "Combo",
            "desc": "A selection box to choose a value from a range of values.\n\n```lua\nhasChildren = true\nhasState = true\nArguments = {\n    Text: string,\n    NoButton: boolean? = false, -- hide the dropdown button.\n    NoPreview: boolean? = false -- hide the preview field.\n}\nEvents = {\n    opened: () -> boolean,\n    closed: () -> boolean,\n    clicked: () -> boolean,\n    hovered: () -> boolean\n}\nStates = {\n    index: State<any>,\n    isOpened: State<boolean>?\n}\n```\n    ",
            "lua_type": "Iris.Combo",
            "tags": [
                "Widget",
                "HasChildren",
                "HasState"
            ],
            "source": {
                "line": 1467,
                "path": "lib/API.lua"
            }
        },
        {
            "name": "ComboArray",
            "desc": "A selection box to choose a value from an array.\n\n```lua\nhasChildren = true\nhasState = true\nArguments = {\n    Text: string,\n    NoButton: boolean? = false, -- hide the dropdown button.\n    NoPreview: boolean? = false -- hide the preview field.\n}\nEvents = {\n    opened: () -> boolean,\n    closed: () -> boolean,\n    clicked: () -> boolean,\n    hovered: () -> boolean\n}\nStates = {\n    index: State<any>,\n    isOpened: State<boolean>?\n}\nExtra = {\n    selectionArray: { any } -- the array to generate a combo from.\n}\n```\n    ",
            "lua_type": "Iris.Combo",
            "tags": [
                "Widget",
                "HasChildren",
                "HasState"
            ],
            "source": {
                "line": 1501,
                "path": "lib/API.lua"
            }
        },
        {
            "name": "ComboEnum",
            "desc": "A selection box to choose a value from an Enum.\n\n```lua\nhasChildren = true\nhasState = true\nArguments = {\n    Text: string,\n    NoButton: boolean? = false, -- hide the dropdown button.\n    NoPreview: boolean? = false -- hide the preview field.\n}\nEvents = {\n    opened: () -> boolean,\n    closed: () -> boolean,\n    clicked: () -> boolean,\n    hovered: () -> boolean\n}\nStates = {\n    index: State<any>,\n    isOpened: State<boolean>?\n}\nExtra = {\n    enumType: Enum -- the enum to generate a combo from.\n}\n```\n    ",
            "lua_type": "Iris.Combo",
            "tags": [
                "Widget",
                "HasChildren",
                "HasState"
            ],
            "source": {
                "line": 1550,
                "path": "lib/API.lua"
            }
        }
    ],
    "types": [],
    "name": "Combo",
    "desc": "Combo Widget API\n    ",
    "source": {
        "line": 1404,
        "path": "lib/API.lua"
    }
}