Variable: transient-enable-menu-navigation

transient-enable-menu-navigation is a customizable variable defined in transient.el.

Value

verbose

Documentation

Whether navigation commands are enabled in the menu buffer.

If the value is verbose (the default), show additional documentation about the command at point in the echo area. If this would result in the same documentation, which is being displayed inside the menu buffer, to be duplicated in the echo area, then verbose forgoes doing so. Use force-verbose to echo even such documentation. If t, enable navigation, but without echoing any documentation.

While a transient is active, the menu buffer is (by default) not the current buffer, making it necessary to use dedicated commands to act on that buffer itself. If this option is non-nil, then the following bindings are available:

- <up> (transient-backward-button) moves the cursor to the previous suffix.
- <down> (transient-forward-button) moves the cursor to the next suffix.
- M-RET (transient-push-button) invokes the suffix the cursor is on.
- \<mouse-1> and \<mouse-2> invoke the clicked on suffix.
- C-r (transient-isearch-backward) and C-s (transient-isearch-forward) start isearch in the menu buffer.

\<mouse-1> and \<mouse-2> are bound in transient-button-map.
All other bindings are in transient-popup-navigation-map.

Instead of \RET, \M-RET is used to invoke the suffix command at point by default, because if a transient allows the invocation of non-suffixes, then it is likely that the user would want the former do what it would do if no transient were active.

This variable was added, or its default value changed, in transient version 0.7.8.

Aliases

transient-enable-popup-navigation (obsolete since transient 0.13.0)

Source Code

;; Defined in ~/.emacs.d/elpa/transient-20260414.1009/transient.el
(defcustom transient-enable-menu-navigation 'verbose
  "Whether navigation commands are enabled in the menu buffer.

If the value is `verbose' (the default), show additional documentation
about the command at point in the echo area.  If this would result in
the same documentation, which is being displayed inside the menu buffer,
to be duplicated in the echo area, then `verbose' forgoes doing so.
Use `force-verbose' to echo even such documentation.  If `t', enable
navigation, but without echoing any documentation.

While a transient is active, the menu buffer is (by default) not the
current buffer, making it necessary to use dedicated commands to act
on that buffer itself.  If this option is non-nil, then the following
bindings are available:

\\<transient-popup-navigation-map>\
- \\[transient-backward-button] moves the cursor to the previous suffix.
- \\[transient-forward-button] moves the cursor to the next suffix.
- \\[transient-push-button] invokes the suffix the cursor is on.
- \\`<mouse-1>' and \\`<mouse-2>' invoke the clicked on suffix.
- \\[transient-isearch-backward]\
 and \\[transient-isearch-forward] start isearch in the menu buffer.

\\`<mouse-1>' and \\`<mouse-2>' are bound in `transient-button-map'.
All other bindings are in `transient-popup-navigation-map'.

Instead of \\`RET', \\`M-RET' is used to invoke the suffix command at point by
default, because if a transient allows the invocation of non-suffixes,
then it is likely that the user would want the former do what it would
do if no transient were active."
  :package-version '(transient . "0.7.8")
  :group 'transient
  :type
  '(choice
    (const :tag "Enable navigation and force showing summary" force-verbose)
    (const :tag "Enable navigation and enable showing summary" verbose)
    (const :tag "Enable navigation commands" t)
    (const :tag "Disable navigation commands" nil)))