UI.OrbitNode

UI.OrbitNode(input: Input): Node

Creates an interactive leaf, constellation destination, or bounded action with priority, optional ring hint, relationships, compact icon, status, selection, busy, and disabled semantics.

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

The complete title, description, status, relationships, and native button semantics remain accessible at every semantic zoom tier.

Common mistakes

• Using a single letter instead of a bounded signalIcon.
• Encoding essential status only through statusTone color.

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

Experimental Constellation Orbit API in 0.5.0-alpha. Verify it against the selected SDK before depending on its shape.

Focused example

UI.OrbitNode {
    id = "map/build",
    title = "Build",
    description = "Compose the interface.",
    nodeKind = "constellation",
    signalIcon = "spark",
    priority = 1,
    onTap = "open-build",
}

Continue learning

Complete inventory