Skip to main content

Text

Text Widget API

Properties​

Text​

Widget
</>
Text.Text: Iris.Text

A text label to display the text argument. The Wrapped argument will make the text wrap around if it is cut off by its parent. The Color argument will change the color of the text, by default it is defined in the configuration file. 

Iris.Window({"Text Demo"})
    Iris.Text({"This is regular text"})
Iris.End()

Example Text 

hasChildren = false
hasState = false
Arguments = {
    Text: string,
    Wrapped: boolean? = [CONFIG] = false, -- whether the text will wrap around inside the parent container. If not specified, then equal to the config
    Color: Color3? = Iris._config.TextColor, -- the colour of the text.
    RichText: boolean? = [CONFIG] = false -- enable RichText. If not specified, then equal to the config
}
Events = {
    hovered: () -> boolean
}

SeparatorText​

Widget
</>
Text.SeparatorText: Iris.SeparatorText

Similar to Iris.Separator but with a text label to be used as a header when an Iris.Tree or Iris.CollapsingHeader is not appropriate.

Visually a full width thin line with a text label clipping out part of the line.

Iris.Window({"Separator Text Demo"})
    Iris.Text({"Regular Text"})
    Iris.SeparatorText({"This is a separator with text"})
    Iris.Text({"More Regular Text"})
Iris.End()

Example Separator Text 

hasChildren = false
hasState = false
Arguments = {
    Text: string
}

InputText​

WidgetHasState
</>
Text.InputText: Iris.InputText

A field which allows the user to enter text.

Iris.Window({"Input Text Demo"})
    local inputtedText = Iris.State("")

    Iris.InputText({"Enter text here:"}, {text = inputtedText})
    Iris.Text({"You entered: " .. inputtedText:get()})
Iris.End()

Example Input Text 

hasChildren = false
hasState = true
Arguments = {
    Text: string? = "InputText",
    TextHint: string? = "", -- a hint to display when the text box is empty.
    ReadOnly: boolean? = false,
    MultiLine: boolean? = false
}
Events = {
    textChanged: () -> boolean, -- whenever the textbox looses focus and a change was made.
    hovered: () -> boolean
}
States = {
    text: State<string>?
}

TextWrapped​

Widget
deprecated in v2.0.0
</>
This was deprecated in v2.0.0
Use 'Text' with the Wrapped argument or change the config.
Text.TextWrapped: Iris.Text

An alias for Iris.Text with the Wrapped argument set to true, and the text will wrap around if cut off by its parent.

hasChildren = false
hasState = false
Arguments = {
    Text: string,
}
Events = {
    hovered: () -> boolean
}

TextColored​

Widget
deprecated in v2.0.0
</>
This was deprecated in v2.0.0
Use 'Text' with the Color argument or change the config.
Text.TextColored: Iris.Text

An alias for Iris.Text with the color set by the Color argument.

hasChildren = false
hasState = false
Arguments = {
    Text: string,
    Color: Color3 -- the colour of the text.
}
Events = {
    hovered: () -> boolean
}
Show raw api
{
    "functions": [],
    "properties": [
        {
            "name": "Text",
            "desc": "A text label to display the text argument.\nThe Wrapped argument will make the text wrap around if it is cut off by its parent.\nThe Color argument will change the color of the text, by default it is defined in the configuration file.\n\n```lua\nIris.Window({\"Text Demo\"})\n    Iris.Text({\"This is regular text\"})\nIris.End()\n```\n\n![Example Text](/Iris/assets/api/text/basicText.png)\n\n```lua\nhasChildren = false\nhasState = false\nArguments = {\n    Text: string,\n    Wrapped: boolean? = [CONFIG] = false, -- whether the text will wrap around inside the parent container. If not specified, then equal to the config\n    Color: Color3? = Iris._config.TextColor, -- the colour of the text.\n    RichText: boolean? = [CONFIG] = false -- enable RichText. If not specified, then equal to the config\n}\nEvents = {\n    hovered: () -> boolean\n}\n```\n    ",
            "lua_type": "Iris.Text",
            "tags": [
                "Widget"
            ],
            "source": {
                "line": 419,
                "path": "lib/API.lua"
            }
        },
        {
            "name": "TextWrapped",
            "desc": "An alias for [Iris.Text](Text#Text) with the Wrapped argument set to true, and the text will wrap around if cut off by its parent.\n\n```lua\nhasChildren = false\nhasState = false\nArguments = {\n    Text: string,\n}\nEvents = {\n    hovered: () -> boolean\n}\n```\n    ",
            "lua_type": "Iris.Text",
            "tags": [
                "Widget"
            ],
            "deprecated": {
                "version": "v2.0.0",
                "desc": "Use 'Text' with the Wrapped argument or change the config."
            },
            "source": {
                "line": 440,
                "path": "lib/API.lua"
            }
        },
        {
            "name": "TextColored",
            "desc": "An alias for [Iris.Text](Text#Text) with the color set by the Color argument.\n\n```lua\nhasChildren = false\nhasState = false\nArguments = {\n    Text: string,\n    Color: Color3 -- the colour of the text.\n}\nEvents = {\n    hovered: () -> boolean\n}\n```\n    ",
            "lua_type": "Iris.Text",
            "tags": [
                "Widget"
            ],
            "deprecated": {
                "version": "v2.0.0",
                "desc": "Use 'Text' with the Color argument or change the config."
            },
            "source": {
                "line": 465,
                "path": "lib/API.lua"
            }
        },
        {
            "name": "SeparatorText",
            "desc": "Similar to [Iris.Separator](Format#Separator) but with a text label to be used as a header\nwhen an [Iris.Tree](Tree#Tree) or [Iris.CollapsingHeader](Tree#CollapsingHeader) is not appropriate.\n\nVisually a full width thin line with a text label clipping out part of the line.\n\n```lua\nIris.Window({\"Separator Text Demo\"})\n    Iris.Text({\"Regular Text\"})\n    Iris.SeparatorText({\"This is a separator with text\"})\n    Iris.Text({\"More Regular Text\"})\nIris.End()\n```\n\n![Example Separator Text](/Iris/assets/api/text/basicSeparatorText.png)\n\n```lua\nhasChildren = false\nhasState = false\nArguments = {\n    Text: string\n}\n```\n    ",
            "lua_type": "Iris.SeparatorText",
            "tags": [
                "Widget"
            ],
            "source": {
                "line": 499,
                "path": "lib/API.lua"
            }
        },
        {
            "name": "InputText",
            "desc": "A field which allows the user to enter text.\n\n```lua\nIris.Window({\"Input Text Demo\"})\n    local inputtedText = Iris.State(\"\")\n\n    Iris.InputText({\"Enter text here:\"}, {text = inputtedText})\n    Iris.Text({\"You entered: \" .. inputtedText:get()})\nIris.End()\n```\n\n![Example Input Text](/Iris/assets/api/text/basicInputText.gif)\n\n```lua\nhasChildren = false\nhasState = true\nArguments = {\n    Text: string? = \"InputText\",\n    TextHint: string? = \"\", -- a hint to display when the text box is empty.\n    ReadOnly: boolean? = false,\n    MultiLine: boolean? = false\n}\nEvents = {\n    textChanged: () -> boolean, -- whenever the textbox looses focus and a change was made.\n    hovered: () -> boolean\n}\nStates = {\n    text: State<string>?\n}\n```\n    ",
            "lua_type": "Iris.InputText",
            "tags": [
                "Widget",
                "HasState"
            ],
            "source": {
                "line": 538,
                "path": "lib/API.lua"
            }
        }
    ],
    "types": [],
    "name": "Text",
    "desc": "Text Widget API\n    ",
    "source": {
        "line": 387,
        "path": "lib/API.lua"
    }
}