The Checkbox mobile component
Toggle boolean values.
A checkbox to toggle a group of boolean values.
Properties
customValidationstring
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.
disabledboolean
Whether user input, interaction, or selection is disabled.
formDataKeystring
The key used by a Form component to assign default values to input fields using form.initialData
, and to construct the form.data
property.
hiddenboolean
Whether the component is visible.
hideValidationMessagestring
Whether to hide the validation message if the input is invalid.
idstring
The name of the component.
invalidboolean
Whether the current value has failed any validation rules.
labelCaptionstring
The additional text to display with the label.
labelsstring[]
A list of labels, by index.
pluginTypestring
The component type.
requiredboolean
Whether the input is required for validation.
validationMessagestring
The validation message to display if the input is invalid.
valuestring[]
A list of selected values.
valuesstring[]
A list of possible values.