Skip to main content

Segemented Control mobile component

Select a single value.

A segmented button to select a single value.

Properties

value
string | number | boolean | null | undefined

The value for the control.

label
string

The text to display as a label for the input field.

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.

id
string

The name of the component.

invalid
boolean

Whether the current value failed 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.

required
boolean

Whether the input is required for validation.

values
string[] | number[] | boolean[]

A list of possible values.