Skip to content
Strife Docs

Reference Field Reference

fields.multiSelect()

Multi-select field storing a plain array of selected values (distinct from select with multiSelect true).

Multiple-choice selection. Maps to editor { name: 'str-multi-select', type: 'multi-select' }.

Distinct from fields.select({ multiSelect: true }): a multi-select combo-box stores { value, name } objects, whereas this editor stores a plain array of the selected value strings.

Example

TypeScript
fields.multiSelect({
  label: 'Tags',
  options: [
    { name: 'News', value: 'news' },
    { name: 'Product', value: 'product' },
  ] as const,
})
// _output: ('news' | 'product')[]

Options

OptionTypeRequiredDescription
label
string
Yes
Label shown to editors in Strife Studio.
options
{ name: string; value: string; color?: string | null }[]
Yes
The selectable choices.
description
string
No
Not shown in Studio's editor panel.
searchable
boolean
No
Stored on the template; nothing uses it today.
filterable
boolean
No
Stored on the template; nothing uses it today.
protected
boolean
No
Stops the field from being edited or removed in Studio's template designer. No effect in the editor panel.
propertyName
string
No
Override the stored property name.
placeholder
string | null
No
Not shown in Strife Studio's editor panel today. The new interface shows it in the picker.
switches
boolean
No
Render selected values as check-mark switches rather than chips.

No localizable option.

Output type

O[number]['value'][] — the array of selected option-value literals (a plain string[]-shaped array narrowed to the option values).

See also

  • Multi Select — the same editor, documented from the Strife Studio UI side.
  • fields.select() — stores {value, name} objects instead of bare values; also supports single-select.