ChoicePicker

A list of options, as checkboxes or chips. The user picks one, or several with variant "multipleSelection". Bind value with { "@path": "/x" } to read the chosen values as a list. Give it a label.

Examples

Loading examples…

Props

PropTypeDescription
checksobject[]Validation rules. The control shows the first failed one
valuestring[]The chosen option values. Bind it with { "@path": "/x" } to a string list
optionsstring | object[]Strings or { "value", "label", "description"? }
labelstringThe visible label of the field. Always set it
variant"multipleSelection" | "mutuallyExclusive"Default "mutuallyExclusive": the user picks one option
displayStyle"checkbox" | "chips"Default "checkbox". "chips" shows the options as pills
filterablebooleanDefault false. Shows a field that filters the options
weightnumberflex-grow in a Row or Column
disabledboolean
requiredboolean

Link to ChoicePicker · All standard components

On this page