← All native models

Native model

workspace_form_field

Declare a named workspace_form_field value and reference it as workspace_form_field.your_name. Models have no separate platform identity or lifecycle.

Topics: Surfaces

Fields

A visible input in a form, bound to one path in the mutation or handler input.

object
childrenOptional
array
Minimum items
0
Maximum items
9223372036854776000
List items
All of these apply
componentRequired
string
Value
"form-field"
controlOptional

Input control to show. By default it is chosen from the input's type.

string
Allowed values
["text","textarea","email","phone","password","number","toggle","select","record-picker","json"]
helpOptional

Short explanation shown with the input. Defaults to the schema's description when there is one.

string
labelOptional

Label shown to users.

string
maximumOptional

Highest allowed number, inclusive, enforced by the server and the form.

number
maxItemsOptional

Maximum number of list items, enforced by the server and the form.

integer
Minimum
0
maxLengthOptional

Maximum text length, enforced by the server and the form.

integer
Minimum
0
minimumOptional

Lowest allowed number, inclusive, enforced by the server and the form.

number
minItemsOptional

Minimum number of list items, enforced by the server and the form.

integer
Minimum
0
minLengthOptional

Minimum text length, enforced by the server and the form.

integer
Minimum
0
pathRequired

Path of this input in the mutation variables or handler input.

string
Minimum length
1
placeholderOptional

Hint text shown in the empty input.

string
readonlyOptional

Set to true to show the value without letting the user change it.

boolean
Allowed values
[true,false]
requiredOptional

Set to true to require a value for this Lua handler input. The server enforces it on every call.

boolean
Allowed values
[true]
sourceOptional

Path in the edited record that supplies the initial value.

string
stateOptional

Workspace state key whose value fills this input. Editing the form does not change that state.

string
submitOptional

always sends the value every time; changed sends it only when the user changed it.

string
Allowed values
["always","changed"]

Only the fields listed here are accepted.