UI.TextInput

UI.TextInput(input: Input): Node

Creates a controlled single-line or multiline field with maximum length, submit action, keyboard hints, autofill metadata, validation semantics, selection preservation, and composition-safe delivery.

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

label is required. required, disabled, and errorId expose state to screen readers; an error hint should be a visible role=alert.

Common mistakes

• Changing value outside application state.
• Treating intermediate IME composition as committed text.

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.TextInput {
    id = "form/email",
    label = "Email",
    value = email,
    onInput = "form.email-change",
    inputType = "email",
    inputMode = "email",
    enterKeyHint = "next",
    required = true,
}

Continue learning

Complete inventory