Skip to main content

Slider

Slider Widget API

A draggable widget with a visual bar constrained between a min and max for each datatype. Allows direct typing input but also dragging the slider by clicking and holding anywhere in the box.

See Input for more details on the arguments.

Properties​

SliderNum​

WidgetHasState
</>
Slider.SliderNum: Iris.SliderNum

A field which allows the user to slide a grip to enter a number within a range. You can ctrl + click to directly input a number, like InputNum. 

hasChildren = false
hasState = true
Arguments = {
    Text: string? = "SliderNum",
    Increment: number? = 1,
    Min: number? = 0,
    Max: number? = 100,
    Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
}
Events = {
    numberChanged: () -> boolean,
    hovered: () -> boolean
}
States = {
    number: State<number>?,
    editingText: State<boolean>?
}

SliderVector2​

WidgetHasState
</>
Slider.SliderVector2: Iris.SliderVector2

A field which allows the user to slide a grip to enter a Vector2 within a range. You can ctrl + click to directly input a Vector2, like InputVector2. 

hasChildren = false
hasState = true
Arguments = {
    Text: string? = "SliderVector2",
    Increment: Vector2? = { 1, 1 },
    Min: Vector2? = { 0, 0 },
    Max: Vector2? = { 100, 100 },
    Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
}
Events = {
    numberChanged: () -> boolean,
    hovered: () -> boolean
}
States = {
    number: State<Vector2>?,
    editingText: State<boolean>?
}

SliderVector3​

WidgetHasState
</>
Slider.SliderVector3: Iris.SliderVector3

A field which allows the user to slide a grip to enter a Vector3 within a range. You can ctrl + click to directly input a Vector3, like InputVector3. 

hasChildren = false
hasState = true
Arguments = {
    Text: string? = "SliderVector3",
    Increment: Vector3? = { 1, 1, 1 },
    Min: Vector3? = { 0, 0, 0 },
    Max: Vector3? = { 100, 100, 100 },
    Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
}
Events = {
    numberChanged: () -> boolean,
    hovered: () -> boolean
}
States = {
    number: State<Vector3>?,
    editingText: State<boolean>?
}

SliderUDim​

WidgetHasState
</>
Slider.SliderUDim: Iris.SliderUDim

A field which allows the user to slide a grip to enter a UDim within a range. You can ctrl + click to directly input a UDim, like InputUDim. 

hasChildren = false
hasState = true
Arguments = {
    Text: string? = "SliderUDim",
    Increment: UDim? = { 0.01, 1 },
    Min: UDim? = { 0, 0 },
    Max: UDim? = { 1, 960 },
    Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
}
Events = {
    numberChanged: () -> boolean,
    hovered: () -> boolean
}
States = {
    number: State<UDim>?,
    editingText: State<boolean>?
}

SliderUDim2​

WidgetHasState
</>
Slider.SliderUDim2: Iris.SliderUDim2

A field which allows the user to slide a grip to enter a UDim2 within a range. You can ctrl + click to directly input a UDim2, like InputUDim2. 

hasChildren = false
hasState = true
Arguments = {
    Text: string? = "SliderUDim2",
    Increment: UDim2? = { 0.01, 1, 0.01, 1 },
    Min: UDim2? = { 0, 0, 0, 0 },
    Max: UDim2? = { 1, 960, 1, 960 },
    Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
}
Events = {
    numberChanged: () -> boolean,
    hovered: () -> boolean
}
States = {
    number: State<UDim2>?,
    editingText: State<boolean>?
}

SliderRect​

WidgetHasState
</>
Slider.SliderRect: Iris.SliderRect

A field which allows the user to slide a grip to enter a Rect within a range. You can ctrl + click to directly input a Rect, like InputRect. 

hasChildren = false
hasState = true
Arguments = {
    Text: string? = "SliderRect",
    Increment: Rect? = { 1, 1, 1, 1 },
    Min: Rect? = { 0, 0, 0, 0 },
    Max: Rect? = { 960, 960, 960, 960 },
    Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.
}
Events = {
    numberChanged: () -> boolean,
    hovered: () -> boolean
}
States = {
    number: State<Rect>?,
    editingText: State<boolean>?
}
Show raw api
{
    "functions": [],
    "properties": [
        {
            "name": "SliderNum",
            "desc": "A field which allows the user to slide a grip to enter a number within a range.\nYou can ctrl + click to directly input a number, like InputNum.\n\n```lua\nhasChildren = false\nhasState = true\nArguments = {\n    Text: string? = \"SliderNum\",\n    Increment: number? = 1,\n    Min: number? = 0,\n    Max: number? = 100,\n    Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.\n}\nEvents = {\n    numberChanged: () -> boolean,\n    hovered: () -> boolean\n}\nStates = {\n    number: State<number>?,\n    editingText: State<boolean>?\n}\n```\n    ",
            "lua_type": "Iris.SliderNum",
            "tags": [
                "Widget",
                "HasState"
            ],
            "source": {
                "line": 1238,
                "path": "lib/API.lua"
            }
        },
        {
            "name": "SliderVector2",
            "desc": "A field which allows the user to slide a grip to enter a Vector2 within a range.\nYou can ctrl + click to directly input a Vector2, like InputVector2.\n\n```lua\nhasChildren = false\nhasState = true\nArguments = {\n    Text: string? = \"SliderVector2\",\n    Increment: Vector2? = { 1, 1 },\n    Min: Vector2? = { 0, 0 },\n    Max: Vector2? = { 100, 100 },\n    Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.\n}\nEvents = {\n    numberChanged: () -> boolean,\n    hovered: () -> boolean\n}\nStates = {\n    number: State<Vector2>?,\n    editingText: State<boolean>?\n}\n```\n    ",
            "lua_type": "Iris.SliderVector2",
            "tags": [
                "Widget",
                "HasState"
            ],
            "source": {
                "line": 1269,
                "path": "lib/API.lua"
            }
        },
        {
            "name": "SliderVector3",
            "desc": "A field which allows the user to slide a grip to enter a Vector3 within a range.\nYou can ctrl + click to directly input a Vector3, like InputVector3.\n\n```lua\nhasChildren = false\nhasState = true\nArguments = {\n    Text: string? = \"SliderVector3\",\n    Increment: Vector3? = { 1, 1, 1 },\n    Min: Vector3? = { 0, 0, 0 },\n    Max: Vector3? = { 100, 100, 100 },\n    Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.\n}\nEvents = {\n    numberChanged: () -> boolean,\n    hovered: () -> boolean\n}\nStates = {\n    number: State<Vector3>?,\n    editingText: State<boolean>?\n}\n```\n    ",
            "lua_type": "Iris.SliderVector3",
            "tags": [
                "Widget",
                "HasState"
            ],
            "source": {
                "line": 1300,
                "path": "lib/API.lua"
            }
        },
        {
            "name": "SliderUDim",
            "desc": "A field which allows the user to slide a grip to enter a UDim within a range.\nYou can ctrl + click to directly input a UDim, like InputUDim.\n\n```lua\nhasChildren = false\nhasState = true\nArguments = {\n    Text: string? = \"SliderUDim\",\n    Increment: UDim? = { 0.01, 1 },\n    Min: UDim? = { 0, 0 },\n    Max: UDim? = { 1, 960 },\n    Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.\n}\nEvents = {\n    numberChanged: () -> boolean,\n    hovered: () -> boolean\n}\nStates = {\n    number: State<UDim>?,\n    editingText: State<boolean>?\n}\n```\n    ",
            "lua_type": "Iris.SliderUDim",
            "tags": [
                "Widget",
                "HasState"
            ],
            "source": {
                "line": 1331,
                "path": "lib/API.lua"
            }
        },
        {
            "name": "SliderUDim2",
            "desc": "A field which allows the user to slide a grip to enter a UDim2 within a range.\nYou can ctrl + click to directly input a UDim2, like InputUDim2.\n\n```lua\nhasChildren = false\nhasState = true\nArguments = {\n    Text: string? = \"SliderUDim2\",\n    Increment: UDim2? = { 0.01, 1, 0.01, 1 },\n    Min: UDim2? = { 0, 0, 0, 0 },\n    Max: UDim2? = { 1, 960, 1, 960 },\n    Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.\n}\nEvents = {\n    numberChanged: () -> boolean,\n    hovered: () -> boolean\n}\nStates = {\n    number: State<UDim2>?,\n    editingText: State<boolean>?\n}\n```\n    ",
            "lua_type": "Iris.SliderUDim2",
            "tags": [
                "Widget",
                "HasState"
            ],
            "source": {
                "line": 1362,
                "path": "lib/API.lua"
            }
        },
        {
            "name": "SliderRect",
            "desc": "A field which allows the user to slide a grip to enter a Rect within a range.\nYou can ctrl + click to directly input a Rect, like InputRect.\n\n```lua\nhasChildren = false\nhasState = true\nArguments = {\n    Text: string? = \"SliderRect\",\n    Increment: Rect? = { 1, 1, 1, 1 },\n    Min: Rect? = { 0, 0, 0, 0 },\n    Max: Rect? = { 960, 960, 960, 960 },\n    Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.\n}\nEvents = {\n    numberChanged: () -> boolean,\n    hovered: () -> boolean\n}\nStates = {\n    number: State<Rect>?,\n    editingText: State<boolean>?\n}\n```\n    ",
            "lua_type": "Iris.SliderRect",
            "tags": [
                "Widget",
                "HasState"
            ],
            "source": {
                "line": 1393,
                "path": "lib/API.lua"
            }
        },
        {
            "name": "InputEnum",
            "desc": "A field which allows the user to slide a grip to enter a number within a range.\nYou can ctrl + click to directly input a number, like InputNum.\n\n```lua\nhasChildren = false\nhasState = true\nArguments = {\n    Text: string? = \"InputEnum\",\n    Increment: number? = 1,\n    Min: number? = 0,\n    Max: number? = 100,\n    Format: string? | { string }? = [DYNAMIC] -- Iris will dynamically generate an approriate format.\n}\nEvents = {\n    numberChanged: () -> boolean,\n    hovered: () -> boolean\n}\nStates = {\n    number: State<number>?,\n    editingText: State<boolean>?,\n    enumItem: EnumItem\n}\n```\n    ",
            "lua_type": "Iris.InputEnum",
            "tags": [
                "Widget",
                "HasState"
            ],
            "private": true,
            "source": {
                "line": 1598,
                "path": "lib/API.lua"
            }
        }
    ],
    "types": [],
    "name": "Slider",
    "desc": "Slider Widget API\n\nA draggable widget with a visual bar constrained between a min and max for each datatype.\nAllows direct typing input but also dragging the slider by clicking and holding anywhere in the box.\n\nSee [Input] for more details on the arguments.\n    ",
    "source": {
        "line": 1208,
        "path": "lib/API.lua"
    }
}