Button

A button to trigger queries and other actions. It supports loading and disabled states, and solid and outline styles.

Properties

Available properties for Button with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read information about components.

NameTypeDescriptionariaLabelstring

An accessible description of the component for screen readers.

clickableboolean

Whether the component has an enabled Click event handler.

disabledboolean

Whether user input, interaction, or selection is disabled.

heightType'fixed' | 'auto'

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

hiddenboolean

Whether the component is visible.

horizontalAlign'stretch' | 'left' | 'center' | 'right'

The horizontal alignment of the contents.

iconAfterIconKey

The icon to display after the primary content.

iconBeforeIconKey

The icon to display before the primary content.

loaderPosition'auto' | 'replace' | 'left' | 'right'

The position of the loading indicator if loading is true.

loadingboolean

Whether to display a loading indicator.

maintainSpaceWhenHiddenboolean

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

marginstring

The amount of margin to render outside of the component.

showInEditorboolean

Whether the component remains visible in the editor if hidden is true.

styleVariant'solid' | 'outline'

The current variant used to style the component.

submitboolean

Whether the button submits the form specified in submitTargetId on click.

submitTargetIdstring

The form to submit when submit is true.

textstring

The primary text content.

tooltipTextstring

The text to display in a tooltip on hover or focus.

Events

Events are triggered by user interactions with Button. Use event handling to trigger queries or other actions in response to events.

NameDescriptionClick

A user clicks the component.

Methods

Methods for interacting with Button. You can write JavaScript almost anywhere in Retool and use methods to manipulate data or components.

NameDescriptionscrollIntoView(options: any)

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

setHidden(hidden: boolean)

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

setDisabled(disabled: boolean)

Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.

Related components