The Checkbox Group component for Retool Apps
A group of checkboxes to toggle boolean values.
Settings
Checkbox Group includes the following configurable options when building apps in the IDE.
Properties
All properties for Checkbox Group with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
captionByIndex
A list of captions for each item, by index.
customValidation
The custom validation message to display if the invalid is true.
disabledByIndex
A list of boolean values for each item, by index, that reflect whether they are disabled.
disabledValues
A list of values not available for selection.
Properties
event
The event type.
Values
change | A user changes the value. |
click | A user clicks or taps the component. |
submit | A user submits the value. |
focus | A user selects the input field. |
blur | A user deselects the input field. |
scan | A user scans a barcode. |
open | A user opens the component. |
close | A user closes the component. |
true | A user sets the value to |
false | A user sets the value to |
select | A user selects a value. |
clear | A user clears the value. |
upload | A user uploads a file. |
parse | An uploaded file is parsed. |
inputValueChange | A user changes the value of the input field. |
method
The JavaScript method to perform when type is datasource, widget, state, or localStorage.
Values
datasource | Control query. |
widget | Control component. |
script | Run script. |
state | Set variable. |
localStorage | Set localStorage. |
util | Perform utility action (e.g., Open URL or Confetti). |
formDataKey
The key used by a Form component to assign default values to input fields using form.initialData, and to construct the form.data property.
global
Whether the object is globally scoped for use in all app pages.
groupLayout
The layout of grouped items.
Values
multiColumn | Display items in multiple columns based on the number of items and size. |
singleColumn | Always display items in a single column. |
wrap | Wrap items. |
heightType
Whether the height automatically resizes to fit content or is a fixed size.
Values
fixed | Fixed height. |
auto | Expand to fit content. |
Whether to hide the validation message if the invalid is true.
id
The unique identifier.
invalid
Whether the value has failed any validation rules.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
The configuration mode for option lists. Either dynamic for mapped options or static for manual options.
Values
dynamic | Options dynamically mapped from an array. |
manual | Options manually configured in the IDE. |
labelAlign
The horizontal alignment of the label.
Values
left | Left of the input field. |
top | Above the input field. |
labelCaption
The label for the node.
labelPosition
The position of the label relative to the input field or value.
Values
top | Above the input field or value. |
left | Left of the input field or value. |
labels
A list of labels for each item. Falls back to the corresponding value if no label is provided.
labelWidth
The label width, in the unit specified in labelWidthUnit.
labelWidthUnit
The specified units for labelWidth, if labelPosition is left.
Values
% | Percent. |
px | Pixels. |
col | Columns. |
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden is true.
minColumnWidth
The minimum width of a column when using a multi-column layout.
overflowType
The overflow behavior when the contents exceeds the height.
Values
scroll | Display a scrollbar. |
pagination | Use pagination. |
pluginType
The plugin type.
selectedIndexes
A list of selected values, by index.
selectedItems
A list of selected items.
selectedLabels
A list of labels for selected values, by index.
showInEditor
Whether to remain visible in the editor if hidden is true.
tooltipByIndex
A list of tooltips for each item, by index.
tooltipText
The tooltip text to display.
validationMessage
The validation message to display if invalid is true.
values
A list of possible values.
Methods
JavaScript API methods for interacting with Checkbox Group. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
clearValidation
Clear the validation message from the input field.
checkboxGroup.clearValidation()
clearValue
Clear the current values.
checkboxGroup.clearValue()
focus
Set focus on the input field.
checkboxGroup.focus()
resetValue
Reset the current value to the default value.
checkboxGroup.resetValue()
scrollIntoView
Scrolls the canvas or parent container so that the selected component appears in the visible area.
checkboxGroup.scrollIntoView(scrollIntoViewOptions)
Parameters
scrollIntoViewOptions
The scroll options.
Properties
behavior
The scroll behavior.
Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block
The scroll position relative to the component.
Values
nearest | Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view. |
start | Scrolls to position the component at the top of the visible area. |
center | Scrolls to position the component in the middle of the visible area. |
end | Scrolls to position the component at the bottom of the visible area. |
setDisabled
Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.
setHidden
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
checkboxGroup.setHidden(hidden)
Parameters
setValue
Set the current value.
Events
Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.
change
The value is changed.