function · ui

spacer

Consumes remaining width inside a horizontal widget group.

ui.spacer()
Stable ID
ui.spacer
Owner
app.ScriptPackageHost
Authority
presentation
Timing
composition
Availability
Phase 14 package callbacks
Side effects
records bounded detached presentation intent
Determinism
Host-created package identity and per-callback budgets.
Introduced
1.19.0

Usage

Consume the remaining horizontal width in the current row group so later widgets align to the far edge. Outside a row group the spacer has no visible effect.

Parameters

Returns

No gameplay value. The call appends one bounded structural presentation intent.

Cost

Counts as one widget against the package composition budget.

Fields

This symbol has no fields.

Errors

Examples

ui.begin_row_group()
ui.text("Village")
ui.spacer()
ui.text("Running")
ui.end_row_group()

API history

Related symbols

Project references