Skip to main content

Button

Rocket 2.0

The Button component runs an action when it is clicked, such as submitting a form, running a query or opening another page. Inside a Form, a click on its submit button submits the form first.

Properties​

Property
Description
Expected Value
LabelText shown on the button.Text. Default: Button
VariantOverall look of the button. Destructive is red for actions that delete or remove data; Link looks like a text link.Default, Secondary, Outline, Ghost, Destructive, Link. Default: Default
SizeHeight and text size of the button.Sm, Default, Lg. Default: Default

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On clickTriggers when the user clicks the button.
On hoverTriggers when the pointer moves onto the button.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
ClickClicks the button, which fires its On click event.components.button1.click()
Set textChanges the button's label until the Label property changes.components.button1.setText("New text")
Set visibilityShows the component when true, hides it when false.components.button1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.button1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.button1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
textText shown on the button.{{components.button1.text}}
variantOverall look of the button. Destructive is red for actions that delete or remove data; Link looks like a text link.{{components.button1.variant}}
sizeHeight and text size of the button.{{components.button1.size}}
buttonTextThe text the button shows now, including a label set with Set text.{{components.button1.buttonText}}
isVisibleWhether the component is visible.{{components.button1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.button1.isLoading}}
isDisabledWhether the component is disabled.{{components.button1.isDisabled}}

Styles​

Style
Default
Button backgroundTheme: Brand primary
Button hover backgroundTheme: Brand primary
Button text colorTheme: Surface 1
Button border colortransparent
Button radius—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.