The Button is an interactive component with a background color, label, and optional icon. You can use a Button to Trigger Actions.

Style Properties

Style properties allow you to customize the look and feel of the component. Combinations of styles applied to components can be saved as Stylesheets to easily reuse styles throughout your app. Styles can also be set dynamically using Variables. To learn more about all the different styling properties and how they work, take a look at Intro to Styling.

Component Specific Styles

PropertyDescription
Active OpacityAllows you to set opacity of the button when active.
Disabled OpacityAllows you to set opacity of the button when disabled.

Configuration Properties

PropertyDescription
Component NameTo alter the name of the component. The name is reflected in the Components tree. Defaults to Button.
Delay Long PressAllows you to set duration (in milliseconds) from On Press before On Long Press is called.
Hit slopAllows you to set additional distance outside of element in which a press can be detected

Data Properties

PropertyDescription
Button TextThe text do display as the button's label
IconAllows you to select an icon from the icon picker to be displayed on the Button (Icon will be on the left of the Label).
Custom IconRender an icon using a string of the icon's identifier. Overrides the 'icon' property. Full list of icons here. Ex: 'Foundation/align-right', 'Feather/check'
LoadingDisplay a loading indicator in the button in lieu of the icon.
DisabledRemoves button functionality and grays out the label and icon.

Conditional Display

You can conditionally display a component based on a given condition. Learn more about conditionally displaying components in the Conditional Display doc.

Triggers

TriggerDescription
On Press Starts the action when the element is pressed.
On Long Press Starts the action when the element is long pressed.