← All native models

Native model

workspace_filter

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

Topics: Surfaces

Fields

An editable filter bound to shared state. Apply or Clear updates the state and reloads the panels that depend on it; it never submits a form.

object
componentRequired
string
Value
"filter"
controlOptional

Input control: text, date or number.

string
Allowed values
["text","date","number"]
emptyOptional

Value stored when the filter is empty: null, or an empty string.

string
Allowed values
["null","string"]
idRequired

Unique identifier: lowercase letters, digits and hyphens, starting with a letter.

string
Minimum length
1
labelRequired

Label shown to users.

string
Minimum length
1
placeholderOptional

Hint text shown in the empty input.

string
resetStateOptional

Space-separated state keys set to null whenever this filter is applied or cleared, such as a pagination cursor.

string
stateRequired

State key the filter edits.

string
Minimum length
1

Only the fields listed here are accepted.