File: transient.el.html

Transient is the library used to implement the keyboard-driven menus in Magit. It is distributed as a separate package, so that it can be used to implement similar menus in other packages.

You can contact the maintainer of this package by sending an email to
<emacs.transient@jonas.bernoulli.dev>, or you can use the public issue
tracker at <https://github.com/magit/transient>. The latter can also be accessed using the forge package, which lets you avoid the sadly non-free javascript on that website.

Defined variables (74)

transient--all-levels-pWhether temporary display of suffixes on all levels is active.
transient--bufferThe transient menu buffer.
transient--buffer-nameName of the transient buffer.
transient--current-suffixThe suffix currently being invoked using a mouse event.
transient--debugWhether to put debug information into *Messages*.
transient--docspWhether docstring-mode is active.
transient--editpWhether edit-mode is active.
transient--exitDo exit the transient.
transient--exitpWhether to exit the transient.
transient--helppWhether help-mode is active.
transient--original-bufferThe buffer that was current before the transient was invoked.
transient--original-windowThe window that was selected before the transient was invoked.
transient--pending-groupThe group that is currently being processed.
transient--pending-suffixThe suffix that is currently being processed.
transient--pre-commandThe pre-command selected for ‘this-command’.
transient--refreshpWhether to refresh the transient completely.
transient--restore-winconfWindow configuration to restore after exiting help.
transient--shadowed-bufferThe buffer that is temporarily shadowed by the transient buffer.
transient--showpWhether to show the transient menu buffer.
transient--stayDo not exit the transient.
transient--windowThe window used to display transient’s menu buffer.
transient-align-variable-pitchWhether to align columns pixel-wise in the menu buffer.
transient-base-mapParent of other keymaps used by Transient.
transient-button-mapOne of the keymaps used when menu navigation is enabled.
transient-common-command-prefixThe prefix key used for most commands common to all menus.
transient-common-commandsCommands available in all transient menus.
transient-current-commandThe transient from which this suffix command was invoked.
transient-current-prefixThe transient from which this suffix command was invoked.
transient-current-suffixesThe suffixes of the transient from which this suffix command was invoked.
transient-default-levelControl what suffix levels are made available by default.
transient-describe-menuWhether to begin the menu buffer with a very short description.
transient-detect-key-conflictsWhether to detect key binding conflicts.
transient-display-buffer-actionThe action used to display transient’s menu buffer.
transient-edit-mapKeymap that is active while a transient in is in "edit mode".
transient-enable-menu-navigationWhether navigation commands are enabled in the menu buffer.
transient-enable-popup-navigationWhether navigation commands are enabled in the menu buffer.
transient-error-on-insert-failureWhether to signal an error when failing to insert a suffix.
transient-exit-hookHook run after exiting a transient menu.
transient-force-fixed-pitchWhether to force use of monospaced font in the menu buffer.
transient-force-single-columnWhether to force use of a single column to display suffixes.
transient-highlight-higher-levelsWhether to highlight suffixes on higher levels.
transient-highlight-mismatched-keysWhether to highlight keys that do not match their argument.
transient-historyHistory of transient commands and infix arguments.
transient-history-fileFile used to save history of transients and their infixes.
transient-history-limitNumber of history elements to keep when saving to file.
transient-levelsLevels of transient commands.
transient-levels-fileFile used to save levels of transients and their suffixes.
transient-mapTop-level keymap used by all transients.
transient-minimal-frame-widthMinimal width of dedicated frame used to display transient menu.
transient-mode-line-formatThe mode-line format for transient’s menu buffer.
transient-navigate-to-group-descriptionsWhether menu navigation commands stop at group descriptions.
transient-popup-navigation-mapOne of the keymaps used when menu navigation is enabled.
transient-post-exit-hookHook run after exiting all transient menus.
transient-predicate-mapBase keymap used to map common commands to their transient behavior.
transient-prefer-reading-valueWhether to prefer reading new value over other value selection methods.
transient-read-with-initial-inputWhether to use the last history element as initial minibuffer input.
transient-resume-modeNon-nil if Transient-Resume mode is enabled.
transient-resume-mode-hookHook run after entering or leaving ‘transient-resume-mode’.
transient-resume-mode-mapKeymap for ‘transient-resume-mode’.
transient-save-historyWhether to save history of transient commands when exiting Emacs.
transient-select-menu-windowWhether to select the window displaying the transient menu.
transient-semantic-coloringWhether to use colors to indicate transient behavior.
transient-setup-buffer-hookHook run when setting up the transient buffer.
transient-show-common-commandsWhether to permanently show common suffix commands in transient menus.
transient-show-docstring-formatHow to display suffix docstrings.
transient-show-during-minibuffer-readWhether to show the transient menu while reading in the minibuffer.
transient-show-menuWhether and when to show transient’s menu in a buffer.
transient-show-popupWhether and when to show transient’s menu in a buffer.
transient-sticky-mapKeymap that is active while an incomplete key sequence is active.
transient-substitute-key-functionFunction used to modify key bindings.
transient-use-accessible-formatsWhether to use a more accessible format strings for menu elements.
transient-use-accessible-valuesWhether to show values in a way that does not rely on coloring.
transient-valuesValues of transient commands.
transient-values-fileFile used to save values of transients.

Defined functions (336)

find-function-advised-original@transient-default-infix(FN FUNC)
transient--active-suffixes(GROUP)
transient--add-face(STRING FACE &optional APPEND BEG END)
transient--advise-this-command(ADVICE)
transient--align-to(STOP)
transient--button-help-echo(WIN BUF POS)
transient--column-stops(COLUMNS)
transient--command-key(CMD)
transient--debug(ARG &rest ARGS)
transient--default-infix-command()
transient--derive-shortarg(ARG)
transient--describe-function(FN)
transient--display-help(HELPER TARGET)
transient--do-call()
transient--do-exit()
transient--do-leave()
transient--do-minus()
transient--do-mouse()
transient--do-move()
transient--do-noop()
transient--do-push-button()
transient--do-quit-all()
transient--do-quit-one()
transient--do-recurse()
transient--do-replace()
transient--do-return()
transient--do-scroll()
transient--do-stack()
transient--do-stay()
transient--do-suffix-p(IF IF-NOT IF-NIL IF-NON-NIL IF-MODE IF-NOT-MODE IF-DERIVED IF-NOT-DERIVED DEFAULT)
transient--do-suspend()
transient--do-warn()
transient--do-warn-inapt()
transient--emergency-exit(&optional ID)
transient--env-apply(FN &optional PREFIX)
transient--exit-and-debug(&rest ARGS)
transient--expand-define-args(ARGS ARGLIST FORM &optional NOBODY)
transient--fit-window-to-buffer(WINDOW)
transient--flatten-suffixes(LAYOUT)
transient--get-children(PREFIX)
transient--get-description(ARG &rest ARGS)
transient--get-extended-value()
transient--get-face(ARG &rest ARGS)
transient--get-format(ARG &rest ARGS)
transient--get-layout(PREFIX)
transient--get-pre-command(&optional CMD KEY ENFORCE-TYPE)
transient--get-savable-value()
transient--get-wrapped-value(OBJ)
transient--goto-argument-description(ARG)
transient--goto-button(OBJECT)
transient--history-init(OBJ)
transient--history-key(OBJ)
transient--history-push(OBJ VALUE)
transient--inapt-suffix-p(OBJ)
transient--init-child(LEVELS SPEC PARENT)
transient--init-group(LEVELS SPEC PARENT)
transient--init-objects(&optional NAME LAYOUT PARAMS)
transient--init-prefix(NAME &optional PARAMS)
transient--init-suffix(LEVELS SPEC PARENT)
transient--init-suffix-key(ARG &rest ARGS)
transient--init-suffixes(NAME)
transient--init-transient(&optional NAME LAYOUT PARAMS)
transient--insert-group(GROUP)
transient--insert-menu(SETUP)
transient--insert-suffix(PREFIX LOC SUFFIX ACTION &optional KEEP-OTHER)
transient--invalid(MSG)
transient--key-face(CMD KEY &optional ENFORCE-TYPE)
transient--key-unreachable-p(OBJ)
transient--load-command-if-autoload(CMD)
transient--locate-child(GROUP LOC)
transient--lookup-key(KEYMAP KEY)
transient--mapn(FUNCTION &rest LISTS)
transient--match-button(OBJECT)
transient--match-child(GROUP LOC CHILD)
transient--maybe-pad-keys(GROUP &optional PARENT)
transient--maybe-set-value(EVENT)
transient--nth(N LIST)
transient--parse-child(PREFIX SPEC)
transient--parse-group(PREFIX SPEC)
transient--parse-suffix(PREFIX SPEC)
transient--pop-keymap(VAR)
transient--post-exit(&optional COMMAND)
transient--pp-to-file(VALUE FILE)
transient--preserve-window-p(&optional NOHIDE)
transient--push-keymap(VAR)
transient--quit-kludge(ACTION)
transient--read-file-contents(FILE)
transient--read-number-N(PROMPT INITIAL-INPUT HISTORY INCLUDE-ZERO)
transient--recursive-edit(FN)
transient--resolve-pre-command(PRE &optional RESOLVE-BOOLEAN CORRECT)
transient--resume-override(&optional IGNORE)
transient--seq-reductions-from(FUNCTION SEQUENCE INITIAL-VALUE)
transient--set-layout(PREFIX LAYOUT)
transient--show-manpage(MANPAGE &optional ARGUMENT)
transient--show-manual(MANUAL)
transient--string-pixel-width(STRING)
transient--suffix-key(SPEC)
transient--suffix-only(&rest REST)
transient--suffix-predicate(SPEC)
transient--suffix-props(LIST)
transient--suffix-prototype(COMMAND)
transient--suspend-override(&optional NOHIDE)
transient--use-level-p(LEVEL &optional EDIT)
transient--use-suffix-p(OBJ)
transient--with-emergency-exit(ID &rest BODY)
transient--with-suspended-override(&rest BODY)
transient-active-prefix(&optional PREFIXES)
transient-append-suffix(PREFIX LOC SUFFIX &optional KEEP-OTHER)
transient-arg-value(ARG ARGS)
transient-args(PREFIX)
transient-argument(&rest _)
transient-argument--eieio-childp(OBJ)
transient-argument-child-p(OBJ)
transient-argument-face(OBJ)
transient-argument-list-p(ARG1)
transient-argument-p(OBJ)
transient-augment-suffix(NAME [KEYWORD VALUE]...)
transient-backward-button(N)
transient-bind-q-to-quit()
transient-buttonize(STRING OBJECT)
transient-child(&rest _)
transient-child--eieio-childp(OBJ)
transient-child-child-p(OBJ)
transient-child-list-p(ARG1)
transient-child-p(OBJ)
transient-column(&rest SLOTS)
transient-column--anon-cmacro(WHOLE &rest SLOTS)
transient-column--eieio-childp(OBJ)
transient-column-child-p(OBJ)
transient-column-list-p(ARG1)
transient-column-p(OBJ)
transient-columns(&rest SLOTS)
transient-columns--anon-cmacro(WHOLE &rest SLOTS)
transient-columns--eieio-childp(OBJ)
transient-columns-child-p(OBJ)
transient-columns-list-p(ARG1)
transient-columns-p(OBJ)
transient-command-completion-not-suffix-only-p(SYMBOL BUFFER)
transient-command-summary-or-name(OBJ)
transient-cons-option(&rest SLOTS)
transient-cons-option--anon-cmacro(WHOLE &rest SLOTS)
transient-cons-option--eieio-childp(OBJ)
transient-cons-option-child-p(OBJ)
transient-cons-option-list-p(ARG1)
transient-cons-option-p(OBJ)
transient-copy-menu-text()
transient-default-value(OBJ)
transient-define-argument(NAME ARGLIST [DOCSTRING] [KEYWORD VALUE]...)
transient-define-group(NAME &rest GROUPS)
transient-define-infix(NAME ARGLIST [DOCSTRING] KEYWORD VALUE [KEYWORD VALUE]...)
transient-define-prefix(NAME ARGLIST [DOCSTRING] [KEYWORD VALUE]... GROUP... [BODY...])
transient-define-suffix(NAME ARGLIST [DOCSTRING] [KEYWORD VALUE]... [BODY...])
transient-describe()
transient-describe-target(&rest SLOTS)
transient-describe-target--anon-cmacro(WHOLE &rest SLOTS)
transient-describe-target--eieio-childp(OBJ)
transient-describe-target-child-p(OBJ)
transient-describe-target-list-p(ARG1)
transient-describe-target-p(OBJ)
transient-echo-arguments(ARG1)
transient-files(&rest SLOTS)
transient-files--anon-cmacro(WHOLE &rest SLOTS)
transient-files--eieio-childp(OBJ)
transient-files-child-p(OBJ)
transient-files-list-p(ARG1)
transient-files-p(OBJ)
transient-format(OBJ)
transient-format-description(OBJ)
transient-format-inapt(ARG &rest ARGS)
transient-format-key(OBJ)
transient-format-value(OBJ)
transient-forward-button(N)
transient-get-suffix(PREFIX LOC)
transient-get-summary(OBJ)
transient-get-value()
transient-group(&rest _)
transient-group--eieio-childp(OBJ)
transient-group-child-p(OBJ)
transient-group-list-p(ARG1)
transient-group-p(OBJ)
transient-help()
transient-history-next()
transient-history-prev()
transient-inapt()
transient-infix(&rest _)
transient-infix--eieio-childp(OBJ)
transient-infix-child-p(OBJ)
transient-infix-list-p(ARG1)
transient-infix-p(OBJ)
transient-infix-read(OBJ)
transient-infix-set(OBJ VALUE)
transient-infix-value(OBJ)
transient-information(&rest SLOTS)
transient-information*(&rest SLOTS)
transient-information*--anon-cmacro(WHOLE &rest SLOTS)
transient-information*--eieio-childp(OBJ)
transient-information*-child-p(OBJ)
transient-information*-list-p(ARG1)
transient-information*-p(OBJ)
transient-information--anon-cmacro(WHOLE &rest SLOTS)
transient-information--eieio-childp(OBJ)
transient-information-child-p(OBJ)
transient-information-list-p(ARG1)
transient-information-p(OBJ)
transient-inhibit-move()
transient-init-return(OBJ)
transient-init-scope(OBJ)
transient-init-value(OBJ)
transient-inline-group(PREFIX GROUP)
transient-insert-suffix(PREFIX LOC SUFFIX &optional KEEP-OTHER)
transient-isearch-abort()
transient-isearch-backward(&optional REGEXP-P)
transient-isearch-cancel()
transient-isearch-exit()
transient-isearch-forward(&optional REGEXP-P)
transient-lisp-variable(&rest SLOTS)
transient-lisp-variable--anon-cmacro(WHOLE &rest SLOTS)
transient-lisp-variable--eieio-childp(OBJ)
transient-lisp-variable--reader(PROMPT INITIAL-INPUT HISTORY)
transient-lisp-variable-child-p(OBJ)
transient-lisp-variable-list-p(ARG1)
transient-lisp-variable-p(OBJ)
transient-maybe-save-history()
transient-noop()
transient-object(&rest _)
transient-object--eieio-childp(OBJ)
transient-object-child-p(OBJ)
transient-object-list-p(ARG1)
transient-object-p(OBJ)
transient-option(&rest SLOTS)
transient-option--anon-cmacro(WHOLE &rest SLOTS)
transient-option--eieio-childp(OBJ)
transient-option-child-p(OBJ)
transient-option-list-p(ARG1)
transient-option-p(OBJ)
transient-parse-suffix(PREFIX SUFFIX)
transient-parse-suffixes(PREFIX SUFFIXES)
transient-prefix(&rest SLOTS)
transient-prefix--anon-cmacro(WHOLE &rest SLOTS)
transient-prefix--eieio-childp(OBJ)
transient-prefix-child-p(OBJ)
transient-prefix-list-p(ARG1)
transient-prefix-object()
transient-prefix-p(OBJ)
transient-prefix-set(VALUE)
transient-prefix-value(OBJ)
transient-preset()
transient-prompt(OBJ)
transient-push-button()
transient-quit-all()
transient-quit-one()
transient-quit-seq()
transient-read-date(PROMPT DEFAULT-TIME HISTORY)
transient-read-directory(PROMPT INITIAL-INPUT HISTORY)
transient-read-existing-directory(PROMPT INITIAL-INPUT HISTORY)
transient-read-existing-file(PROMPT INITIAL-INPUT HISTORY)
transient-read-file(PROMPT INITIAL-INPUT HISTORY)
transient-read-number-N+(PROMPT INITIAL-INPUT HISTORY)
transient-read-number-N0(PROMPT INITIAL-INPUT HISTORY)
transient-read-string-from-buffer(PROMPT VALUE _)
transient-rebind-quit-commands(OBJ)
transient-remove-suffix(PREFIX LOC)
transient-replace-suffix(PREFIX LOC SUFFIX)
transient-reset()
transient-reset-value(OBJ)
transient-resume()
transient-resume-mode(&optional ARG)
transient-row(&rest SLOTS)
transient-row--anon-cmacro(WHOLE &rest SLOTS)
transient-row--eieio-childp(OBJ)
transient-row-child-p(OBJ)
transient-row-list-p(ARG1)
transient-row-p(OBJ)
transient-save()
transient-save-and-exit()
transient-save-value(OBJ)
transient-scope(&optional PREFIXES CLASSES)
transient-scroll-down(&optional ARG)
transient-scroll-up(&optional ARG)
transient-set()
transient-set-and-exit()
transient-set-default-level(COMMAND LEVEL)
transient-set-level(&optional COMMAND LEVEL)
transient-set-value(OBJ)
transient-setup(&optional NAME LAYOUT EDIT &rest PARAMS)
transient-setup-children(GROUP CHILDREN)
transient-show()
transient-show-help(OBJ)
transient-subgroups(&rest SLOTS)
transient-subgroups--anon-cmacro(WHOLE &rest SLOTS)
transient-subgroups--eieio-childp(OBJ)
transient-subgroups-child-p(OBJ)
transient-subgroups-list-p(ARG1)
transient-subgroups-p(OBJ)
transient-suffix(&rest SLOTS)
transient-suffix--anon-cmacro(WHOLE &rest SLOTS)
transient-suffix--eieio-childp(OBJ)
transient-suffix-child-p(OBJ)
transient-suffix-list-p(ARG1)
transient-suffix-object(&optional COMMAND)
transient-suffix-p(OBJ)
transient-suffix-put(PREFIX LOC PROP VALUE)
transient-suffixes(PREFIX)
transient-suspend()
transient-switch(&rest SLOTS)
transient-switch--anon-cmacro(WHOLE &rest SLOTS)
transient-switch--eieio-childp(OBJ)
transient-switch-child-p(OBJ)
transient-switch-list-p(ARG1)
transient-switch-p(OBJ)
transient-switches(&rest SLOTS)
transient-switches--anon-cmacro(WHOLE &rest SLOTS)
transient-switches--eieio-childp(OBJ)
transient-switches-child-p(OBJ)
transient-switches-list-p(ARG1)
transient-switches-p(OBJ)
transient-toggle-common()
transient-toggle-debug()
transient-toggle-docstrings(&optional ARG1)
transient-toggle-level-limit()
transient-undefined()
transient-update()
transient-value-face(OBJ &optional (ACTIVE nil SACTIVE))
transient-value-preset(&rest SLOTS)
transient-value-preset--anon-cmacro(WHOLE &rest SLOTS)
transient-value-preset--eieio-childp(OBJ)
transient-value-preset-child-p(OBJ)
transient-value-preset-list-p(ARG1)
transient-value-preset-p(OBJ)
transient-variable(&rest _)
transient-variable--eieio-childp(OBJ)
transient-variable-child-p(OBJ)
transient-variable-list-p(ARG1)
transient-variable-p(OBJ)
transient-with-help-window(&rest BODY)
transient-with-shadowed-buffer(&rest BODY)

Defined faces (22)

transient-active-infixFace used for the infix for which the value is being read.
transient-argumentFace used for enabled arguments.
transient-delimiterFace used for delimiters and separators. This includes the parentheses around values and the pipe character used to separate possible values from each other.
transient-disabled-suffixFace used for disabled levels while editing suffix levels. See info node ‘(transient)Enabling and Disabling Suffixes’.
transient-enabled-suffixFace used for enabled levels while editing suffix levels. See info node ‘(transient)Enabling and Disabling Suffixes’.
transient-headingFace used for headings.
transient-higher-levelFace optionally used to highlight suffixes on higher levels. See also option ‘transient-highlight-higher-levels’.
transient-inactive-argumentFace used for inactive arguments.
transient-inactive-valueFace used for inactive values.
transient-inapt-argumentFace used for inapt arguments with a (currently ignored) value. Depending on the type this is used for the argument and/or value.
transient-inapt-suffixFace used for suffixes that are inapt at this time.
transient-keyFace used for keys.
transient-key-exitFace used for keys of suffixes that exit the menu.
transient-key-recurseFace used for keys of sub-menus whose suffixes return to the parent menu.
transient-key-returnFace used for keys of suffixes that return to the parent menu.
transient-key-stackFace used for keys of sub-menus that exit the parent menu.
transient-key-stayFace used for keys of suffixes that don’t exit the menu.
transient-mismatched-keyFace optionally used to highlight keys without a short-argument. See also option ‘transient-highlight-mismatched-keys’.
transient-nonstandard-keyFace optionally used to highlight keys conflicting with short-argument. See also option ‘transient-highlight-mismatched-keys’.
transient-unreachableFace used for suffixes unreachable from the current prefix sequence.
transient-unreachable-keyFace used for keys unreachable from the current prefix sequence.
transient-valueFace used for values.