Skip to main content

IconSwap

Swap between an array of icons.

Types

IconSwapProps

interface IconSwapProps {
...IconButtonProps--

All IconButton properties are accepted.

Options{string}?--

Array of image strings to swap between

Selectionnumber?--

The currently selected option index

}
Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "IconSwapProps",
            "desc": "",
            "fields": [
                {
                    "name": "...",
                    "lua_type": "IconButtonProps",
                    "desc": "All IconButton properties are accepted."
                },
                {
                    "name": "Options",
                    "lua_type": "{string}?",
                    "desc": "Array of image strings to swap between"
                },
                {
                    "name": "Selection",
                    "lua_type": "number?",
                    "desc": "The currently selected option index"
                }
            ],
            "source": {
                "line": 15,
                "path": "src/Components/IconSwap.luau"
            }
        }
    ],
    "name": "IconSwap",
    "desc": "Swap between an array of icons.",
    "source": {
        "line": 6,
        "path": "src/Components/IconSwap.luau"
    }
}