summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJoseph Turner <joseph@breatheoutbreathe.in>2024-11-27 09:22:59 -0800
committerJonas Bernoulli <jonas@bernoul.li>2024-12-01 14:45:38 +0100
commit590181262b515d7fbbfedc9e18575bdeb7fc767c (patch)
tree37f86eda6dc01d3ebf5a8b4d3c3cefc184854546 /docs
parent3539231b9889da877005955e5f537fe0e507bdff (diff)
transient-prefix: Add display-action slot
This change lets each transient-prefix display according to its own display-buffer-action. Closes #303.
Diffstat (limited to 'docs')
-rw-r--r--docs/transient.org10
-rw-r--r--docs/transient.texi11
2 files changed, 19 insertions, 2 deletions
diff --git a/docs/transient.org b/docs/transient.org
index ccdecac..9a9eaaa 100644
--- a/docs/transient.org
+++ b/docs/transient.org
@@ -522,6 +522,9 @@ Also see [[* Common Suffix Commands]].
If you change the value of this option, then you might also
want to change the value of ~transient-mode-line-format~.
+ This user option may be overridden if ~:display-action~ is passed
+ when creating a new prefix with ~transient-define-prefix~.
+
*** Accessibility Options
:PROPERTIES:
:UNNUMBERED: notoc
@@ -1951,6 +1954,9 @@ functions use ~describe-function~.
against a specific value, as returned by ~transient-infix-value~,
for example, ~--option=one~.
+- ~display-action~ determines how this prefix is displayed, overriding
+ ~transient-display-buffer-action~. It should have the same type.
+
- ~scope~ For some transients it might be necessary to have a sort of
secondary value, called a “scope”. See ~transient-define-prefix~.
@@ -2170,7 +2176,9 @@ See [[*Enabling and Disabling Suffixes]].
:UNNUMBERED: notoc
:END:
-Yes, see ~transient-display-buffer-action~ in [[*Configuration]].
+Yes, see ~transient-display-buffer-action~ in [[*Configuration]]. You can
+also control how the popup buffer is displayed on a case-by-case basis
+by passing ~:display-action~ to ~transient-define-prefix~.
** How can I copy text from the popup buffer?
:PROPERTIES:
diff --git a/docs/transient.texi b/docs/transient.texi
index 32f2aa7..74af03a 100644
--- a/docs/transient.texi
+++ b/docs/transient.texi
@@ -684,6 +684,9 @@ then that unfortunately changes which buffer is current.
If you change the value of this option, then you might also
want to change the value of @code{transient-mode-line-format}.
+
+This user option may be overridden if @code{:display-action} is passed
+when creating a new prefix with @code{transient-define-prefix}.
@end defopt
@anchor{Accessibility Options}
@@ -2215,6 +2218,10 @@ against a specific value, as returned by @code{transient-infix-value},
for example, @code{--option=one}.
@item
+@code{display-action} determines how this prefix is displayed, overriding
+@code{transient-display-buffer-action}. It should have the same type.
+
+@item
@code{scope} For some transients it might be necessary to have a sort of
secondary value, called a ``scope''. See @code{transient-define-prefix}.
@end itemize
@@ -2489,7 +2496,9 @@ See @ref{Enabling and Disabling Suffixes}.
@anchor{Can I control how the popup buffer is displayed?}
@appendixsec Can I control how the popup buffer is displayed?
-Yes, see @code{transient-display-buffer-action} in @ref{Configuration}.
+Yes, see @code{transient-display-buffer-action} in @ref{Configuration}. You can
+also control how the popup buffer is displayed on a case-by-case basis
+by passing @code{:display-action} to @code{transient-define-prefix}.
@anchor{How can I copy text from the popup buffer?}
@appendixsec How can I copy text from the popup buffer?