Skip to main content

The Outline Button component for Retool Apps

A button to trigger actions when clicked.

Outline Button is a preset version of Button. The styleVariant proprety has been preconfigured to outline.

For more information about using the Outline Button 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.

allowWrap

Whether content can wrap to multiple lines.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Appearance > Wrap text
Default
true
Examples
true

ariaLabel

The accessible label for screen readers.

Type string
Format Plain Text
Mutability
ControlUsage
Retool UI Inspector > Content > Accessible name
Default
null
Examples
"Retool logo."

clickable

Whether there is an enabled Click event handler.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Interaction > Event handlers
Default
false
Examples
true

disabled

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

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Interaction > Disabled
MethodsetDisabled()
Default
false
Examples
true

heightType

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

Type string
Format Plain Text
Mutability
ControlUsage
Retool UI Inspector > Spacing > Height
Allowed Values
ValueDescription
fixed

Fixed height.

auto

Expand to fit content.

Default
fixed

hidden

Whether this object is hidden from view.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Appearance > Hidden
MethodsetHidden()
Default
false
Examples
true

horizontalAlign

Horizontal alignment of the button.

Type string
Format Plain Text
Mutability
ControlUsage
Retool UI Inspector > Appearance > Align
Allowed Values
ValueDescription
left

Left alignment.

center

Center alignment.

right

Right alignment.

stretch

Stretch to fit.

Default
left
Examples
"center"

iconAfter

The suffix icon to display.

Type string
Format Icon Key
Mutability
ControlUsage
Retool UI Inspector > Content > Add-ons > Suffix icon
Default
null
Examples
/icon:bold/shopping-gift

iconBefore

The prefix icon to display.

Type string
Format Icon Key
Mutability
ControlUsage
Retool UI Inspector > Content > Add-ons > Prefix icon
Default
null
Examples
/icon:bold/shopping-gift

id

The unique identifier (name).

Type string
Format Plain Text
Mutability
ControlUsage
Retool UI Inspector
Default
outlineButton1
Examples
query1
button1

isHiddenOnDesktop

Whether to show or hide this object in the desktop layout.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Appearance > Advanced > Show on desktop
Default
false
Examples
true

isHiddenOnMobile

Whether to show or hide this object in the mobile layout.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Appearance > Advanced > Show on mobile
Default
true
Examples
true

loaderPosition

The position of the loading indicator if loading is true.

Type string
Mutability
ControlUsage
Retool UI Inspector > Interaction > Loader position
Allowed Values
ValueDescription
auto

Position automatically.

replace

Replace the text.

left

Left of text.

right

Right of text.

Default
auto

loading

Whether to display a loading indicator.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Interaction > Loading
Default
false
Examples
true

maintainSpaceWhenHidden

Whether to take up space on the canvas if hidden is true.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Appearance > Advanced > Maintain space when hidden
Default
false
Examples
true

margin

The amount of margin to render outside.

Type string
Format Plain Text
Mutability
ControlUsage
Retool UI Inspector > Spacing > Margin
Allowed Values
ValueUI OptionDescription
4px 8pxNormal

Normal margin.

0None

No margin.

Default
4px 8px
Examples
4px 8px

showInEditor

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

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Appearance > Advanced > Always show in edit mode
Default
false
Examples
true

style

Custom style options.

Type object
Mutability
ControlUsage
Retool UI Inspector > Appearance > style

styleVariant

The style variant to use.

Type string
Format Plain Text
Mutability
ControlUsage
Retool UI Inspector > Appearance > Variant
Allowed Values
ValueDescription
solid

Solid style.

outline

Outline style.

Default
outline
Examples
solid

submit

Whether to submit using the submitTargetId property when clicked.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Interaction > Type
Default
false
Examples
true

submitTargetId

The form to submit when the submit property is true.

Type string
Format Retool object name
Mutability Read-only
Default
null
Examples
form1

text

The primary text content.

Type string
Format Plain Text
Mutability
ControlUsage
Retool UI Inspector > Content > Add-ons > Text
Examples
Submit

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

outlineButton.setDisabled()

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

Definition
outlineButton.setDisabled(disabled)
Parameters

disabled

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

Type boolean
Format True/False
Default
false
Examples
true

Examples

Disable outlineButton.

outlineButton.setDisabled(true);

Enable outlineButton.

outlineButton.setDisabled(false);

outlineButton.setHidden()

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

Definition
outlineButton.setHidden(hidden)
Parameters

hidden

Whether this object is hidden from view.

Type boolean
Format True/False
Default
false
Examples
true

Examples

Hide outlineButton.

outlineButton.setHidden(true);

Unhide outlineButton.

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

EventDescription
ClickAn item is clicked or pressed.