summaryrefslogtreecommitdiffstats
path: root/doc/classes/CheckBox.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/CheckBox.xml')
-rw-r--r--doc/classes/CheckBox.xml1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/classes/CheckBox.xml b/doc/classes/CheckBox.xml
index 9d98a1c1ed..699073f9d3 100644
--- a/doc/classes/CheckBox.xml
+++ b/doc/classes/CheckBox.xml
@@ -6,6 +6,7 @@
<description>
A checkbox allows the user to make a binary choice (choosing only one of two possible options). It's similar to [CheckButton] in functionality, but it has a different appearance. To follow established UX patterns, it's recommended to use CheckBox when toggling it has [b]no[/b] immediate effect on something. For example, it could be used when toggling it will only do something once a confirmation button is pressed.
See also [BaseButton] which contains common properties and methods associated with this node.
+ [b]Note:[/b] CheckBox changes its appearance when it's configured as a radio button. See various [code]radio_*[/code] theme properties. To configure CheckBox to act as a radio button, use [member BaseButton.button_group] and [ButtonGroup].
</description>
<tutorials>
</tutorials>