Skip to main content

Multiselect mobile component

Select multiple values from a list.

A dropdown option field to select multiple values. Multiselect uses a full-screen list box that contains a search filter.

Multiselect

Properties

customValidation
string

A JavaScript conditional statement for custom validation logic. If the statement evaluates to a string, validation fails and it is rendered as the error message. An empty or nullish value is treated as valid input.

disabled
boolean

Whether user input, interaction, or selection is disabled.

formDataKey
string

The key used by a Form component to assign default values to input fields using form.initialData, and to construct the form.data property.

hideValidationMessage
string

Whether to hide the validation message if the input is invalid.

hidden
boolean

Whether the component is visible.

id
string

The name of the component.

invalid
boolean

Whether the current value has failed any validation rules.

labelCaption
string

The additional text to display with the label.

labelPosition
'top'

The label position.

labels
string[]

A list of labels, by index.

pluginType
string

The component type.

required
boolean

Whether the input is required for validation.

validationMessage
string

The validation message to display if the input is invalid.

value
string[]

A list of selected values.

values
string[]

A list of possible values.