Skip to main content

Format

Format API

Properties​

Separator​

Widget
</>
Format.Separator: Iris.Separator

A vertical or horizonal line, depending on the context, which visually seperates widgets.

Iris.Window({"Separator Demo"})
    Iris.Text({"Some text here!"})
    Iris.Separator()
    Iris.Text({"This text has been separated!"})
Iris.End()

Example Separator 

hasChildren = false
hasState = false

Indent​

WidgetHasChildren
</>
Format.Indent: Iris.Indent

Indents its child widgets.

Iris.Window({"Indent Demo"})
    Iris.Text({"Unindented text!"})
    Iris.Indent()
        Iris.Text({"This text has been indented!"})
    Iris.End()
Iris.End()

Example Indent 

hasChildren = true
hasState = false
Arguments = {
    Width: number? = Iris._config.IndentSpacing -- indent width ammount.
}

SameLine​

WidgetHasChildren
</>
Format.SameLine: Iris.SameLine

Positions its children in a row, horizontally.

Iris.Window({"Same Line Demo"})
    Iris.Text({"All of these buttons are on the same line!"})
    Iris.SameLine()
        Iris.Button({"Button 1"})
        Iris.Button({"Button 2"})
        Iris.Button({"Button 3"})
    Iris.End()
Iris.End()

Example SameLine 

hasChildren = true
hasState = false
Arguments = {
    Width: number? = Iris._config.ItemSpacing.X, -- horizontal spacing between child widgets.
    VerticalAlignment: Enum.VerticalAlignment? = Enum.VerticalAlignment.Center -- how widgets vertically to each other.
    HorizontalAlignment: Enum.HorizontalAlignment? = Enum.HorizontalAlignment.Center -- how widgets are horizontally.
}

Group​

WidgetHasChildren
</>
Format.Group: Iris.Group

Layout widget which contains its children as a single group.

hasChildren = true
hasState = false
Show raw api
{
    "functions": [],
    "properties": [
        {
            "name": "Separator",
            "desc": "A vertical or horizonal line, depending on the context, which visually seperates widgets.\n\n```lua\nIris.Window({\"Separator Demo\"})\n    Iris.Text({\"Some text here!\"})\n    Iris.Separator()\n    Iris.Text({\"This text has been separated!\"})\nIris.End()\n```\n\n![Example Separator](/Iris/assets/api/format/basicSeparator.png)\n\n```lua\nhasChildren = false\nhasState = false\n```\n    ",
            "lua_type": "Iris.Separator",
            "tags": [
                "Widget"
            ],
            "source": {
                "line": 299,
                "path": "lib/API.lua"
            }
        },
        {
            "name": "Indent",
            "desc": "Indents its child widgets.\n\n```lua\nIris.Window({\"Indent Demo\"})\n    Iris.Text({\"Unindented text!\"})\n    Iris.Indent()\n        Iris.Text({\"This text has been indented!\"})\n    Iris.End()\nIris.End()\n```\n\n![Example Indent](/Iris/assets/api/format/basicIndent.png)\n\n```lua\nhasChildren = true\nhasState = false\nArguments = {\n    Width: number? = Iris._config.IndentSpacing -- indent width ammount.\n}\n```\n    ",
            "lua_type": "Iris.Indent",
            "tags": [
                "Widget",
                "HasChildren"
            ],
            "source": {
                "line": 328,
                "path": "lib/API.lua"
            }
        },
        {
            "name": "SameLine",
            "desc": "Positions its children in a row, horizontally.\n\n```lua\nIris.Window({\"Same Line Demo\"})\n    Iris.Text({\"All of these buttons are on the same line!\"})\n    Iris.SameLine()\n        Iris.Button({\"Button 1\"})\n        Iris.Button({\"Button 2\"})\n        Iris.Button({\"Button 3\"})\n    Iris.End()\nIris.End()\n```\n\n![Example SameLine](/Iris/assets/api/format/basicSameLine.png)\n\n```lua\nhasChildren = true\nhasState = false\nArguments = {\n    Width: number? = Iris._config.ItemSpacing.X, -- horizontal spacing between child widgets.\n    VerticalAlignment: Enum.VerticalAlignment? = Enum.VerticalAlignment.Center -- how widgets vertically to each other.\n    HorizontalAlignment: Enum.HorizontalAlignment? = Enum.HorizontalAlignment.Center -- how widgets are horizontally.\n}\n```\n    ",
            "lua_type": "Iris.SameLine",
            "tags": [
                "Widget",
                "HasChildren"
            ],
            "source": {
                "line": 361,
                "path": "lib/API.lua"
            }
        },
        {
            "name": "Group",
            "desc": "Layout widget which contains its children as a single group.\n\n```lua\nhasChildren = true\nhasState = false\n```\n    ",
            "lua_type": "Iris.Group",
            "tags": [
                "Widget",
                "HasChildren"
            ],
            "source": {
                "line": 376,
                "path": "lib/API.lua"
            }
        }
    ],
    "types": [],
    "name": "Format",
    "desc": "Format API\n    ",
    "source": {
        "line": 276,
        "path": "lib/API.lua"
    }
}