UI.Text

UI.Text(input: Input): Node

Renders selectable semantic text with body or heading meaning, line alignment, status roles, and inherited or local foreground and background colors. Width controls the box in which textAlign operates.

Mental model

This is a declarative node: app.render describes it again from current state, while the host matches its stable id to the existing view.

Before you use it

Add luastra/ui to this module's dependencies in luastra.json, then import it with require("luastra/ui"). The project must declare the ui.render capability. app.render must return one UI.Screen root; place this node inside that tree rather than invoking it for a hidden side effect.

How it fits

The constructor validates its fields immediately and returns a UI.Node. After app.render returns, the host reconciles that node by stable id with the current semantic DOM-based interface. Current desktop and mobile hosts package the same web artifact; native adapters are used at capability boundaries.

Shared parameter groups

Parameters

Children and layout

This component does not accept arbitrary child nodes; named parameters provide its content.

Accessibility and keyboard

variant creates the real h1/h2/h3 hierarchy; textAlign changes visual alignment only, not reading order.

Common mistakes

• Treating textAlign=center as node positioning; it aligns lines only within Text width.
• Creating a visual heading without the matching variant.

Returns

Node — a validated declarative UI node that becomes part of the next host-neutral render tree.

What happens next

A validated declarative node appears after it is returned as part of the current render tree.

Failures and fixes

Invalid fields, duplicate IDs, unsupported child combinations, or a missing ui.render capability fail during check, render-tree validation, or host startup.

Availability

Source API in 0.5.0-alpha; the public installer targets 0.5.0-alpha. Verify host-specific behavior against the selected SDK.

Focused example

UI.Text {
    id = "page/title",
    width = "full",
    text = "Centered title",
    variant = "title",
    textAlign = "center",
    textColor = "accent",
}

Continue learning

Complete inventory