The Checkbox Group component for Retool Mobile
A group of checkboxes to toggle boolean values.
Properties
All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
disabled
Whether input, interaction, selection, or triggering is disabled.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Interaction > Disabled |
| Default | false |
Examples
falsetrue
events
A list of configured event handlers that trigger actions or queries.
| Type | array |
| Array values | object |
| Configurability | Inspector > Interaction > Event handlers |
| Default | null |
Array Object Properties
event
The event that triggers the action. Refer to the events section for details of available events for this object.
| Type | string |
| Configurability | Inspector > Interaction > Event handlers > Event |
| Default | null |
method
The JavaScript method to perform when type is datasource, widget, state, or localStorage.
| Type | string |
| Configurability | Inspector > Interaction > Event handlers > Edit event handler > Run script actions |
| Default | null |
type
The type of action to perform.
| Type | string | ||||||||||||||
| Configurability | Inspector > Interaction > Event handlers > Edit event handler > Action | ||||||||||||||
| Allowed Values |
| ||||||||||||||
| Default | null |
hidden
Whether this object is hidden from view.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Hidden |
| Default | false |
Examples
falsetrue
label
The text label to display.
| Type | string |
| Format | Plain Text |
| Configurability | Inspector > Content > Add-ons > Label > Label |
| Default | null |
Examples
false"Label"
labelCaption
The additional text to display with the label.
| Type | string |
| Format | Plain Text |
| Configurability | Inspector > Content > Add-ons > Label > Caption |
| Default | null |
labels
A list of labels for each item. Falls back to the corresponding value if no label is provided.
| Type | array |
| Array values | string |
| Configurability | Read-only |
| Default | [] |
Examples
false["Label 1", "Label 2", "Label 3"]
values
A list of possible values from which to select.
| Type | array |
| Configurability | Read-only |
| Default | null |
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
checkboxGroup.clearValidation()
Clear the validation message from the input field.
checkboxGroup.clearValidation()
Examples
Clear the validation message from checkboxGroup.
checkboxGroup.clearValidation();
checkboxGroup.clearValue()
Clear the current values.
checkboxGroup.clearValue()
Examples
Clear the current value of checkboxGroup.
checkboxGroup.clearValue();
checkboxGroup.focus()
Set focus on the component.
checkboxGroup.focus()
Examples
Set focus on checkboxGroup.
checkboxGroup.focus();
checkboxGroup.resetValue()
Reset the current value to the default value.
checkboxGroup.resetValue()
Examples
Reset the current value of checkboxGroup.
checkboxGroup.resetValue();
checkboxGroup.setDisabled()
Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.
checkboxGroup.setDisabled(disabled)
Parameters
disabled
Whether input, interaction, selection, or triggering is disabled.
| Type | boolean |
| Format | True/False |
| Default | |
Examples
true
Examples
Disable checkboxGroup.
checkboxGroup.setDisabled(true);
Enable checkboxGroup.
checkboxGroup.setDisabled(false);
checkboxGroup.setHidden()
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
checkboxGroup.setHidden(hidden)
Parameters
Examples
true
Examples
Hide checkboxGroup.
checkboxGroup.setHidden(true);
Unhide checkboxGroup.
checkboxGroup.setHidden(false);
checkboxGroup.setValue()
Set the current value.
checkboxGroup.setValue(value)
Examples
Set the current value of checkboxGroup to userValue.
checkboxGroup.setValue(userValue);
checkboxGroup.validate()
Validates the value of the input field.
checkboxGroup.validate()
Examples
Validate the value of checkboxGroup.
checkboxGroup.validate();
Events
Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.
| Event | Description |
|---|---|
| Change | The value is changed. |