summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJonas Bernoulli <jonas@bernoul.li>2026-03-03 20:41:03 +0100
committerJonas Bernoulli <jonas@bernoul.li>2026-03-03 20:41:03 +0100
commit1fc27186f58a9284e086bdb6906d02a6e138a4e5 (patch)
treee4b28f88f546fc579c1102c94d9a29566a0d711d /docs
parent8ee92853e4f0b4d3c7be9744bd6e37e91680c044 (diff)
transient-use-accessible-values: New option
Diffstat (limited to 'docs')
-rw-r--r--docs/transient.org22
-rw-r--r--docs/transient.texi22
2 files changed, 44 insertions, 0 deletions
diff --git a/docs/transient.org b/docs/transient.org
index ca074f5..58d8779 100644
--- a/docs/transient.org
+++ b/docs/transient.org
@@ -776,6 +776,28 @@ text at point, to be run when a transient menu is active, for example:
of being toggled off on first invocation, or instead of cycling through
values.
+- User Option: transient-use-accessible-values ::
+
+ This option controls whether values are shown in a way that does not
+ rely on coloring.
+
+ If this is ~nil~ (the default), then colors are used to communicate the
+ state of arguments. For certain argument types the state is solely
+ communicated that way. For example, an enabled command-line switch is
+ shown using some bright color, and disabling that argument, changes the
+ color to gray, without otherwise changing the displayed text.
+
+ This default does not work for visually impaired user. If this option
+ is non-~nil~, then the state is additionally communicated through other
+ means. A switch, for example, is either followed by "is enabled" or
+ "is disabled". How exactly the state is communicated depends on the
+ type of the infix command.
+
+ Note that packages, which use Transient, can define their own infix
+ command types, which may or may not involve overriding Transient's
+ code, which honors this new option. I.e., it will take some time until
+ everything respects this setting.
+
- User Option: transient-use-accessible-formats ::
This option controls whether more accessible format strings are used
diff --git a/docs/transient.texi b/docs/transient.texi
index b0676c6..a188ce9 100644
--- a/docs/transient.texi
+++ b/docs/transient.texi
@@ -930,6 +930,28 @@ of being toggled off on first invocation, or instead of cycling through
values.
@end defopt
+@defopt transient-use-accessible-values
+This option controls whether values are shown in a way that does not
+rely on coloring.
+
+If this is @code{nil} (the default), then colors are used to communicate the
+state of arguments. For certain argument types the state is solely
+communicated that way. For example, an enabled command-line switch is
+shown using some bright color, and disabling that argument, changes the
+color to gray, without otherwise changing the displayed text.
+
+This default does not work for visually impaired user. If this option
+is non-@code{nil}, then the state is additionally communicated through other
+means. A switch, for example, is either followed by "is enabled" or
+"is disabled". How exactly the state is communicated depends on the
+type of the infix command.
+
+Note that packages, which use Transient, can define their own infix
+command types, which may or may not involve overriding Transient's
+code, which honors this new option. I.e., it will take some time until
+everything respects this setting.
+@end defopt
+
@defopt transient-use-accessible-formats
This option controls whether more accessible format strings are used
for menu elements.