Button Node

Buttons are clickable elements of your application, analogous to the HTML button tag.

Buttons can be clicked using a mouse or assistive device. When clicked, buttons will trigger their click event.

A button is disabled when Enabled is set to false. When disabled, buttons will not trigger their click events and a disabled cursor will be shown on hover.

Properties

Visible

PropbuttonNode.isVisible
Typeboolean
Default{{true}}

Whether or not this node is visible.

Enabled

PropbuttonNode.isEnabled
Typeboolean
Default{{true}}

Whether or not this node is enabled.

Tooltip

PropbuttonNode.tooltip
Typestring
Defaultundefined

The tooltip text to display when hovered or focused over this node.

Top

PropbuttonNode.top
Typestring
Default1

The position of the node from the top side of the grid (grid-row-start).

Left

PropbuttonNode.left
Typestring
Default1

The position of the node from the left side of the grid (grid-column-start).

Width

PropbuttonNode.width
Typestring
Default128px

The width of the node. When this node is in a grid layout, this should be done using unitless grid column units (specifying 4 will become grid-column-end: span 4). When this node is in a stack layout, the width must be specified using CSS units (e.g. 100px or 100%).

Min Width

PropbuttonNode.minWidth
Typestring
Defaultnone

The minimum width of the node. When this node is in a grid layout, this property is ignored.

Max Width

PropbuttonNode.maxWidth
Typestring
Defaultnone

The maximum width of the node. When this node is in a grid layout, this property is ignored.

Height

PropbuttonNode.height
Typestring
Default32px

The height of the node. When this node is in a grid layout, this should be done using unitless grid row units (specifying 4 will become grid-row-end: span 4). When this node is in a stack layout, the height must be specified using CSS units (e.g. 100px or 100%).

Min Height

PropbuttonNode.minHeight
Typestring
Defaultnone

The minimum height of the node. When this node is in a grid layout, this property is ignored.

Max Height

PropbuttonNode.maxHeight
Typestring
Defaultnone

The minimum height of the node. When this node is in a grid layout, this property is ignored.

Overflow

PropbuttonNode.overflow
TypeOverflow ('auto' | 'visible' | 'hidden' | 'scroll')
Defaultauto

The strategy used to handle overflow in the horizontal and vertical axes for content that is larger than its container.

Overflow X

PropbuttonNode.overflowX
TypeOverflow ('auto' | 'visible' | 'hidden' | 'scroll')
Defaultauto

The strategy used to handle overflow in the horizontal axis for content that is larger than its container.

Overflow Y

PropbuttonNode.overflowY
TypeOverflow ('auto' | 'visible' | 'hidden' | 'scroll')
Defaultauto

The strategy used to handle overflow in the vertical axis for content that is larger than its container.

Custom Styles

PropbuttonNode.styles
Typestring
Defaultelement.styles { }

Custom CSS styles to be applied to the node. Use element.styles to refer to the current node.

Text

PropbuttonNode.text
Typestring
DefaultButton

The text to display in the button's label.

Left Icon

PropbuttonNode.leftIcon
Typestring
Defaultundefined

The icon to display on the left side of the button.

Right Icon

PropbuttonNode.rightIcon
Typestring
Defaultundefined

The icon to display on the right side of the button.

Text Color

PropbuttonNode.textColor
Typestring
Defaultwhite

The text color of the button's label.

Font Size

PropbuttonNode.fontSize
TypeFontSize ('xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl' | '3xl' | '4xl')
Defaultsm

The font size of the button's label.

Border Radius

PropbuttonNode.borderRadius
Typestring
Default6px

The radius of the rounded corners of button's border (perimeter). Supports the same values as the corresponding CSS property.

Padding

PropbuttonNode.padding
Typestring
Default4px

The interior padding of the button.

Background Color

PropbuttonNode.backgroundColor
Typestring
Defaultpurple.700

The background color of the button.

Hover Background Color

PropbuttonNode.hoverBackgroundColor
Typestring
Defaultundefined

The background color of the button when it is hovered over or focused.

Type

PropbuttonNode.type
TypeFormButtonTypes ('submit' | 'reset' | 'auto')
Defaultauto

The HTML type value for the input element.

Event Handlers

On Click

HandlerbuttonNode.onClick

Called when the user clicks the button. Use this event to trigger downstream actions when this button is clicked.