The Button Group component for Retool Apps
A group of buttons to trigger actions when clicked.
For more information about using the Button Group component, refer to the buttons and links guide.
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.
alignment
Whether content can wrap to multiple lines.
Type | boolean | ||||||||
Format | True/False | ||||||||
Mutability |
| ||||||||
Allowed Values |
| ||||||||
Default |
|
Examples
true
heightType
Whether the height automatically adjusts to fit content or is a fixed size.
Type | string | ||||||
Format | Plain Text | ||||||
Mutability |
| ||||||
Allowed Values |
| ||||||
Default |
|
hidden
Whether this object is hidden from view.
Type | boolean | ||||||
Format | True/False | ||||||
Mutability |
| ||||||
Default |
|
Examples
true
id
The unique identifier (name).
Type | string | ||||
Format | Plain Text | ||||
Mutability |
| ||||
Default |
|
Examples
query1
button1
isHiddenOnDesktop
Whether to show or hide this object in the desktop layout.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
true
isHiddenOnMobile
Whether to show or hide this object in the mobile layout.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
true
maintainSpaceWhenHidden
Whether to take up space on the canvas if hidden
is true
.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
true
margin
The amount of margin to render outside.
Type | string | |||||||||
Format | Plain Text | |||||||||
Mutability |
| |||||||||
Allowed Values |
| |||||||||
Default |
|
Examples
4px 8px
overflowMode
Whether to use a scrolling experience or wrap the visible items when heightType
is auto
.
Type | string | ||||||
Format | Plain Text | ||||||
Mutability |
| ||||||
Allowed Values |
| ||||||
Default |
|
overflowPosition
The index after which items are placed in an overflow menu.
Type | number | ||||
Format | Integer | ||||
Mutability |
| ||||
Default |
|
Examples
2
overlayMaxHeight
The maximum height of the options list, in pixels.
Type | number | ||||
Format | Integer | ||||
Mutability |
| ||||
Default |
|
Examples
200
overlayMinWidth
The minimum width of the options list, in pixels.
Type | number | ||||
Format | Integer | ||||
Mutability |
| ||||
Default |
|
Examples
200
showInEditor
Whether the component remains visible in the editor if hidden
is true
.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
true
style
Custom style options.
Type | object | ||||
Mutability |
|
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
buttonGroup.scrollIntoView()
Scrolls the canvas or parent container so that the selected component appears in the visible area.
buttonGroup.scrollIntoView(options)
Parameters
Object Properties
behavior
The scroll behavior.
Type | string | ||||||
Allowed Values |
|
block
The scroll position relative to the component.
Type | string | ||||||||||
Allowed Values |
|
Examples
Scroll the minimum amount to immediately bring buttonGroup
into view.
buttonGroup.scrollIntoView({behavior: 'auto', block: 'nearest'});
buttonGroup.setHidden()
Set the hidden
value to toggle whether the component is visible. Defaults to true
without a parameter.
buttonGroup.setHidden(hidden)
Parameters
Examples
true
Examples
Hide buttonGroup
.
buttonGroup.setHidden(true);
Unhide buttonGroup
.
buttonGroup.setHidden(false);
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 |
---|---|
Click | An item is clicked or pressed. |