Skip to main content
An input is a text field. It commits when the player clicks away or presses enter, not on every keystroke.
Input, keybind, and color picker elements
Inputs are full-width and live at the tab level. Create them directly on the tab, not inside a group.

Properties

name
string
The label.
description
string
Hint text under the label. Optional.
icon
string | number
An icon shown beside the label. Optional.
value
string
The initial text.
placeholder
string
Ghost text shown while the field is empty.
numeric
boolean
default:"false"
Accept numbers only. Commits a clean number, and clears if the text is malformed.
clearOnFocus
boolean
default:"false"
Empty the field when it gains focus.
flag
string
default:"name"
The save key. Optional.
forgetState
boolean
default:"false"
Skip saving.
callback
function
Runs with the text on commit.

Handle

.value
string
The current text.
Set(value, skipCallback?)
Set the text.