This option controls whether the current transient’s infix and suffix commands are shown in the popup buffer.
t(the default) then the popup buffer is shown as soon as a transient prefix command is invoked.
nil, then the popup buffer is not shown unless the user explicitly requests it, by pressing an incomplete prefix key sequence.
The popup is shown when the user explicitly requests it by pressing an incomplete prefix key sequence. Unless this is zero, then the popup is shown after that many seconds of inactivity (using the absolute value).
This option controls whether navigation commands are enabled in the transient popup buffer.
While a transient is active the transient popup buffer is not the current buffer, making it necessary to use dedicated commands to act on that buffer itself. This is disabled by default. If this option is non-nil, then the following features are available:
<up>moves the cursor to the previous suffix.
<down>moves the cursor to the next suffix.
RETinvokes the suffix the cursor is on.
<mouse-1>invokes the clicked on suffix.
C-rstart isearch in the popup buffer.
This option specifies the action used to display the transient popup
buffer. The transient popup buffer is displayed in a window using
(display-buffer BUFFER transient-display-buffer-action).
The value of this option has the form
(FUNCTION . ALIST), where
FUNCTION is a function or a list of functions. Each such function
should accept two arguments: a buffer to display and an alist of the
same form as ALIST. See (elisp)Choosing Window.
The default is
(display-buffer-in-side-window (side . bottom)).
This displays the window at the bottom of the selected frame.
Another useful value is
(display-buffer-below-selected). This is
magit-popup used by default. For more alternatives see
(elisp)Display Action Functions.
It may be possible to display the window in another frame, but whether that works in practice depends on the window-manager. If the window manager selects the new window (Emacs frame), then it doesn’t work.
If you change the value of this option, then you might also want
to change the value of
This option controls whether the transient popup buffer has a mode-line, separator line, or neither.
nil, then the buffer has no mode-line. If the buffer is not
displayed right above the echo area, then this probably is not a
line (the default), then the buffer also has no mode-line, but a
thin line is drawn instead, using the background color of the face
transient-separator. Termcap frames cannot display thin lines and
therefore fallback to treating
Otherwise this can be any mode-line format. See (elisp)Mode Line Format for details.
This option controls whether the last history element is used as the
initial minibuffer input when reading the value of an infix argument
from the user. If
nil, then there is no initial input and the first
element has to be accessed the same way as the older elements.
This option controls whether key bindings of infix commands that do not match the respective command-line argument should be highlighted. For other infix commands this option has no effect.
When this option is non-nil, then the key binding for an infix argument
is highlighted when only a long argument (e.g.
specified but no shorthand (e.g
-v). In the rare case that a
shorthand is specified but the key binding does not match, then it
is highlighted differently.
Highlighting mismatched key bindings is useful when learning the arguments of the underlying command-line tool; you wouldn’t want to learn any short-hands that do not actually exist.
The highlighting is done using one of the faces
This function is used to modify key bindings. If the value of this option is nil (the default), then no substitution is performed.
This function is called with one argument, the prefix object, and
must return a key binding description, either the existing key
description it finds in the
key slot, or the key description that
replaces the prefix key. It could be used to make other
substitutions, but that is discouraged.
= is hard to reach using my custom keyboard layout,
so I substitute
( for that, which is easy to reach using a layout
optimized for lisp.
(setq transient-substitute-key-function (lambda (obj) (let ((key (oref obj key))) (if (string-match "\\`\\(=\\)[a-zA-Z]" key) (replace-match "(" t t key 1) key))))
This option controls whether key binding conflicts should be detected at the time the transient is invoked. If so, then this results in an error, which prevents the transient from being used. Because of that, conflicts are ignored by default.
Conflicts cannot be determined earlier, i.e. when the transient is being defined and when new suffixes are being added, because at that time there can be false-positives. It is actually valid for multiple suffixes to share a common key binding, provided the predicates of those suffixes prevent that more than one of them is enabled at a time.
This option controls whether to force the use of a monospaced font
in popup buffer. Even if you use a proportional font for the
default face, you might still want to use a monospaced font in
transient’s popup buffer. Setting this option to t causes
to be remapped to
fixed-pitch in that buffer.