Skip to content

Button ui-button-group Added In: v1.3.0

Adds a set of buttons that act as a multi-state switch to your dashboard. When an individual button is clicked, it will become active and all other buttons in the group will become inactive, with the newly selected value being emitted from the node in Node-RED.

The selected option can be set by sending a msg.payload with the value of the button to be selected.


GroupDefines which group of the UI Dashboard this widget will render in.
SizeControls the width of the button with respect to the parent group. Maximum value is the width of the group.
LabelThe text shown within the button.
AppearanceSpecify whether the shape of the widget should be rectangular or have rounded corners.
Use theme colorsSpecify whether the theme colors should be used. If not active, custom colors can be specified for each option separately.
OptionsSpecify which options need to be displayed. Each option can specify a label, icon, value and color.
TopicThe text that needs to be send in the msg.topic field.
PassthroughSpecify whether input messages should be passed through as output messages.


Examples of a Button GroupExample of some rendered button groups in a Dashboard.