Skip to main content

Radio Button

This node places a radio button in the visual tree. The Radio Button must be placed in a Radio Button Group node to function properly.

You must specify a unique Value for each Radio Button node. Only one Radio Button in a Radio Button Group can be selected at once.

The core radio button has a very simple visual appearance and is most often used in other components as part of a design system. This control contains all logic such as accessibility etc. It can be styled in via it's properties, or you can use it only for the logic and create your own radio button component in your own design system.

Inputs

The main input of the Radio Button node is the Value input:

DataDescription
ValueThe value for this radio button. The value of the selected radio button in a radio button group will be passed as the Value output of the radio button group. All radio buttons in a group should have unique values.
Background ColorThe background color when the radio button is "checked".

It can be enabled and disabled using the Enabled input:

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

The Checkbox 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.
SpacingThe spacing between the label and the checkbox.

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.
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 of the Radio Button node is the Checked output.

DataDescription
CheckedA boolean output that is true when this radio button control is checked and false if not. This is useful when using this control as a base for your own component that will represent visually that it is checked.

It also features a set of signals:

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

States

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

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

This node supports the following Visual Output Properties:

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

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