Skip to main content

The Button Group component for Retool Apps

A group of buttons to trigger actions when clicked.

Demo

For more information about this component, refer to the Buttons and links guide.

Settings​

Button Group includes the following configurable options when building apps in the IDE.

AlignEvent handlersHeightShow on desktopShow on mobileMaintain space when hiddenMarginMax list heightMin list widthAlways show in edit modeStylesHelper text

Properties​

All properties for Button Group with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

The horizontal alignment of the contents.

Values
left

Left alignment.

center

Center alignment.

right

Right alignment.

stretched

Justified alignment

events​

object[]

A list of configured event handlers that trigger actions or queries.

Properties

event​

enum

The event type. Refer to the events section for a list of supported events.

method​

enum

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

The type of action to perform.

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).

global​

boolean

Whether the object is globally scoped for use in all app pages.

Whether the height automatically resizes to fit content or is a fixed size.

Values
fixed

Fixed height.

auto

Expand to fit content.

​

boolean

Whether the component is visible.

id​

string

The unique identifier.

Whether the component is visible in the desktop layout.

Whether the component is visible in the mobile layout.

Whether the component takes up space on the canvas if hidden is true.

The amount of margin to render outside.

Values
4px 8px

Normal margin.

0

No margin.

overflowMode​

enum

Whether to use a scrolling experience or wrap the visible buttons when heightType is 'auto'.

Values
scroll

Allow scrolling of visible buttons.

wrap

Wrap visible buttons.

overflowPosition​

number

The index after which buttons are placed in an overflow menu.

The maximum height of the dropdown, in pixels.

The minimum width of the dropdown, in pixels.

pluginType​

string

The plugin type.

Whether to remain visible in the editor if hidden is true.

style​

object

Custom style options in use. Not all style options may be available for all components.

The tooltip text to display.

Methods​

JavaScript API methods for interacting with Button Group. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

scrollIntoView​

Scrolls the canvas or parent container so that the selected component appears in the visible area.

component.scrollIntoView(scrollIntoViewOptions)
Parameters

scrollIntoViewOptions​

object

The scroll options.

Properties

behavior​

enum

The scroll behavior.

Values
auto

Scroll immediately to the specified position.

smooth

Scroll gradually to the specified position.

block​

enum

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.

setHidden​

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

component.setHidden(hidden)
Parameters

​

boolean

Whether the component is visible.

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.

click​

The item is clicked or pressed.