Skip to main content

The Button Group component for Retool Apps

A group of buttons to trigger actions when clicked.

This is a legacy component that is no longer supported. Use the newer version of this component which has more features and functionality.

Settings​

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

DisabledShow on desktopShow on mobileLabelLabel max-widthAlways show label on the leftMaintain space when hiddenMarginAlways show in edit modeStylesHelper textValue

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.

Whether input, interaction, selection, or triggering is disabled.

global​

boolean

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

​

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.

label​

string

The text label to display.

The maximum label width, in px.

Whether to show the label to the left.

labels​

string

A list of labels for each item. Falls back to the corresponding value if no label is provided.

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.

onChange​

The event handler to run when the value changes.

pluginType​

string

The plugin type.

renderAsHtml​

boolean

Whether to render the text as HTML.

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.

The value.

values​

A list of possible values.

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.

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

setValue​

Set the current value.

buttonGroup.setValue(value)
Parameters

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