UI.Scroll

UI.Scroll(input: Input): Node

Creates a bounded vertical or horizontal scrolling region and preserves its children as one navigable group. It prevents oversized content from forcing the surrounding screen beyond its intended bounds while allowing wheel input on the unused axis to continue through the surrounding page.

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

Content of the scrollable region.

Accessibility and keyboard

A stable id, logical render-tree order, and visible labels preserve predictable keyboard and screen-reader navigation.

Common mistakes

• Using a duplicate id or an uppercase path segment.
• Passing a shared-group parameter that is not listed on this component page.

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.Scroll {
    id = "filters/scroll",
    width = "full",
    scroll = "horizontal",
    UI.Row {
        id = "filters/items",
        flow = "nowrap",
        UI.Button { id = "filters/all", text = "All", onTap = "filter-all" },
        UI.Button { id = "filters/new", text = "New", onTap = "filter-new" },
    },
}

Continue learning

Complete inventory