Skip to content

SBCheckButton

Nikita Yudin edited this page Feb 13, 2024 · 2 revisions

SBCheckButton icon SBCheckButton

Inherits: SBButton

A button that represents a binary choice.

Description

CheckButton is a toggle button displayed as multiple buttons. See more: ButtonGroup.

Properties

Let's look on list of all available properties:

Name Type Default Description
buttons_text Array[String] [] The button's text that will be displayed inside the value button's area.
buttons_count int 2 The number of buttons.
multiple_select bool false If true, multiple buttons can be toggled.
allow_unpress bool false If true, it is possible to unpress all buttons.vvv
check_button_theme Theme The check button's theme.
buttons_container HBoxContainer Container for the check buttons.
buttons Array[Button] [] All the check buttons.

Methods

After we initialize we have its initialized instance in variable with helpful methods:

Name Return Description
get_button(idx: int) Button Returns the check button.

Theme Properties

SpinButton comes with some theme properties that you apply for styling.

See Theme Module


Signals

Name Description
button_toggled(text_button: String, toggled_on: bool) Emitted when a button is toggled.