summaryrefslogtreecommitdiffstats
path: root/doc/classes/CheckBox.xml
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2021-11-20 17:43:34 +0100
committerHugo Locurcio <hugo.locurcio@hugo.pro>2021-12-15 18:22:39 +0100
commita1ab50a9f050bbd0ef5af4c799743e7aea46c48f (patch)
treed9f9408226ff90fa6bdf0fdd68b293d5c5dda48a /doc/classes/CheckBox.xml
parent1cbf3947d60e1edd39101ebd806d641d54cf53f1 (diff)
downloadredot-engine-a1ab50a9f050bbd0ef5af4c799743e7aea46c48f.tar.gz
Document that transparent StyleBoxes/textures should be used for UI focus
Diffstat (limited to 'doc/classes/CheckBox.xml')
-rw-r--r--doc/classes/CheckBox.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/CheckBox.xml b/doc/classes/CheckBox.xml
index 32ef70a5cf..6180f56858 100644
--- a/doc/classes/CheckBox.xml
+++ b/doc/classes/CheckBox.xml
@@ -76,7 +76,7 @@
The [StyleBox] to display as a background when the [CheckBox] is disabled.
</theme_item>
<theme_item name="focus" data_type="style" type="StyleBox">
- The [StyleBox] to display as a background when the [CheckBox] is focused.
+ The [StyleBox] to display as a background when the [CheckBox] is focused. The [code]focus[/code] [StyleBox] is displayed [i]over[/i] the base [StyleBox], so a partially transparent [StyleBox] should be used to ensure the base [StyleBox] remains visible. A [StyleBox] that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a [StyleBoxEmpty] resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.
</theme_item>
<theme_item name="hover" data_type="style" type="StyleBox">
The [StyleBox] to display as a background when the [CheckBox] is hovered.