Skip to main content

Button

This node places a customizable button in the visual tree.

The button has a Click signal that you can use to trigger actions.

This control contains all logic such as accessibility etc. It can be styled in via it's properties. Use variations to create different types of buttons

Inputs

The Button can be enabled and disabled using the Enabled input:

@include "../../shared-props/inputs/_enabled.md"

The Button node has a set of label properties that can be set:

DataDescription
Enable LabelSets whether the label is visible or not.
Text StyleSet an existing text style to this node, or create a new text style from the current properties.
LabelA text string that will be shown as the label on the button.

Similarly, it has a set of icon properties:

DataDescription
Enable IconSets whether the icon is visible or not.
TypeUse this to set if you want to use a predefined icon or a custom image from the project folder.
SourceWhere to get the icon.
SpacingThe spacing between the text and the icon.
PlacementSets whether the icon should be to the left or to the right of the Label
SizeThe width of the icon in px.
ColorSets the color of the icon. Only visible if Type is set to icon.

Visual

This node supports the following Visual Input Properties:

Outputs

The main output for the button is the Click signal:

SignalDescription
ClickA signal is sent on this output when the button is clicked.

It also features a set of more in depth signals:

@include "../../shared-props/outputs/_control-events.md"

States

Apart from triggering signals the Button node also notifies of its state through data outputs:

@include "../../shared-props/outputs/_control-states.md"

Visual

This node supports the following Visual Output Properties:

@include "../../shared-props/inputs/_visual-input-properties.md"

@include "../../shared-props/outputs/_visual-output-properties.md"