Skip to main content

Text

For displaying text. Lorem ipsum dolo..

Types​

TextProps​

</>
interface TextProps {
...: BaseProps--

All Base properties are accepted.

Text: string?--

The text to display.

TextColor3: Color3?--

The color of the text.

TextSize: number?--

The size of the text.

RichText: boolean?--

Whether the text supports rich text formatting.

FontFace: Font?--

The font face of the text.

TextWrapped: boolean?--

Whether the text should wrap when it exceeds the label's width.

TextXAlignment: Enum.TextXAlignment?--

The horizontal alignment of the text.

TextYAlignment: Enum.TextYAlignment?--

The vertical alignment of the text.

Font: Enum.Font?--

The font of the text (deprecated, use FontFace instead).

TextScaled: boolean?--

Whether the text should scale to fit the label.

TextTruncate: boolean?--

Whether the text should truncate when it exceeds the label's width.

LineHeight: number?--

The line height of the text.

LocalizedText: string?--

The localized text to display.

MaxVisibleGraphemes: number?--

The maximum number of visible graphemes.

TextTransparency: number?--

The transparency of the text.

}
Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "TextProps",
            "desc": "",
            "fields": [
                {
                    "name": "...",
                    "lua_type": "BaseProps",
                    "desc": "All Base properties are accepted."
                },
                {
                    "name": "Text",
                    "lua_type": "string?",
                    "desc": "The text to display."
                },
                {
                    "name": "TextColor3",
                    "lua_type": "Color3?",
                    "desc": "The color of the text."
                },
                {
                    "name": "TextSize",
                    "lua_type": "number?",
                    "desc": "The size of the text."
                },
                {
                    "name": "RichText",
                    "lua_type": "boolean?",
                    "desc": "Whether the text supports rich text formatting."
                },
                {
                    "name": "FontFace",
                    "lua_type": "Font?",
                    "desc": "The font face of the text."
                },
                {
                    "name": "TextWrapped",
                    "lua_type": "boolean?",
                    "desc": "Whether the text should wrap when it exceeds the label's width."
                },
                {
                    "name": "TextXAlignment",
                    "lua_type": "Enum.TextXAlignment?",
                    "desc": "The horizontal alignment of the text."
                },
                {
                    "name": "TextYAlignment",
                    "lua_type": "Enum.TextYAlignment?",
                    "desc": "The vertical alignment of the text."
                },
                {
                    "name": "Font",
                    "lua_type": "Enum.Font?",
                    "desc": "The font of the text (deprecated, use FontFace instead)."
                },
                {
                    "name": "TextScaled",
                    "lua_type": "boolean?",
                    "desc": "Whether the text should scale to fit the label."
                },
                {
                    "name": "TextTruncate",
                    "lua_type": "boolean?",
                    "desc": "Whether the text should truncate when it exceeds the label's width."
                },
                {
                    "name": "LineHeight",
                    "lua_type": "number?",
                    "desc": "The line height of the text."
                },
                {
                    "name": "LocalizedText",
                    "lua_type": "string?",
                    "desc": "The localized text to display."
                },
                {
                    "name": "MaxVisibleGraphemes",
                    "lua_type": "number?",
                    "desc": "The maximum number of visible graphemes."
                },
                {
                    "name": "TextTransparency",
                    "lua_type": "number?",
                    "desc": "The transparency of the text."
                }
            ],
            "source": {
                "line": 28,
                "path": "src/Components/Text.luau"
            }
        }
    ],
    "name": "Text",
    "desc": "For displaying text. *Lorem ipsum dolo..*",
    "source": {
        "line": 6,
        "path": "src/Components/Text.luau"
    }
}