File: which-key.el.html

The which-key mode displays the key bindings following your currently entered incomplete command (a prefix) in a popup. For example, after enabling the minor mode if you enter C-x and wait for the default of 1 second the minibuffer will expand with all of the available key bindings that follow C-x (or as many as space allows given your settings).

This includes prefixes like C-x 8 which are shown in a different face.

Defined variables (72)

which-key--automatic-displayNon-nil if popup was triggered with automatic update.
which-key--bufferHolds reference to which-key buffer.
which-key--debug-buffer-nameIf non-nil, use this buffer for debug messages.
which-key--echo-keystrokes-backupBackup the initial value of ‘echo-keystrokes’.
which-key--frameHolds reference to which-key frame.
which-key--god-mode-key-stringString to use for god-mode support.
which-key--god-mode-support-enabledSupport god-mode if non-nil.
which-key--last-try-2-locLast location of side-window when two locations used.
which-key--paging-timerHolds reference to timer for paging.
which-key--prefix-help-cmd-backupBackup the value of ‘prefix-help-command’.
which-key--secondary-timer-activeNon-nil if the secondary timer is active.
which-key--timerHolds reference to open window timer.
which-key-C-h-mapKeymap for C-h commands.
which-key-C-h-map-promptPrompt to display when invoking ‘which-key-C-h-map’.
which-key-add-column-paddingAdditional spaces to add to the left of each key column.
which-key-allow-evil-operatorsAllow popup to show for evil operators.
which-key-allow-imprecise-window-fitAllow which-key to use a simpler method for resizing the popup.
which-key-allow-multiple-replacementsAllow a key binding to be modified by multiple elements.
which-key-allow-regexpsA list of regexp strings to use to filter key sequences.
which-key-buffer-nameName of which-key buffer.
which-key-compute-remapsIf non-nil, show remapped commands.
which-key-custom-hide-popup-functionSet a custom hide-popup function.
which-key-custom-popup-max-dimensions-functionSet a custom max-dimensions function.
which-key-custom-show-popup-functionSet a custom show-popup function.
which-key-delay-functionsList of functions that may delay the which-key popup.
which-key-dont-use-unicodeIf non-nil, don’t use any unicode characters in default setup.
which-key-echo-keystrokesValue to use for ‘echo-keystrokes’.
which-key-ellipsisEllipsis to use when truncating.
which-key-extra-keymapsList of extra keymaps to show entries from.
which-key-frame-max-heightMaximum height of which-key popup when type is frame.
which-key-frame-max-widthMaximum width of which-key popup when type is frame.
which-key-hide-alt-key-translationsHide key translations using Alt key if non nil.
which-key-highlighted-command-listRules used to highlight certain commands.
which-key-idle-delayDelay (in seconds) for which-key buffer to popup.
which-key-idle-secondary-delaySeconds to wait for which-key to pop up after initial display.
which-key-inhibitPrevent which-key from popping up momentarily.
which-key-inhibit-display-hookHook run before display of which-key popup.
which-key-inhibit-regexpsA list of regexp strings to use to filter key sequences.
which-key-init-buffer-hookHook run when which-key buffer is initialized.
which-key-keymap-historyHistory of keymap selections.
which-key-lighterMinor mode lighter to use in the mode-line.
which-key-max-description-lengthTruncate the description of keys to this length.
which-key-max-display-columnsMaximum number of columns to display in the which-key buffer.
which-key-min-column-description-widthEvery column should at least have this width.
which-key-min-display-linesMinimum number of horizontal lines to display in the which-key buffer.
which-key-modeNon-nil if Which-Key mode is enabled.
which-key-mode-hookHook run after entering or leaving ‘which-key-mode’.
which-key-mode-mapKeymap for ‘which-key-mode’.
which-key-paging-keyKey to use for changing pages.
which-key-paging-prefixesEnable paging for these prefixes.
which-key-persistent-popupWhether or not to disable ‘which-key--hide-popup’.
which-key-popup-typeSupported types are minibuffer, side-window, frame, and custom.
which-key-prefix-prefixPrefix string to indicate a key bound to a keymap.
which-key-preserve-window-configurationSave and restore window configuration around which-key popup display.
which-key-replacement-alistALIST for manipulating display of binding descriptions.
which-key-separatorSeparator to use between key and description.
which-key-show-docstringsIf non-nil, show each command’s docstring in the which-key popup.
which-key-show-early-on-C-hAllow C-h (‘help-char’) to trigger which-key popup before timer.
which-key-show-operator-state-mapsShow the keys following an evil command that reads a motion.
which-key-show-prefixWhether to and where to display the current prefix sequence.
which-key-show-remaining-keysShow remaining keys in last slot, when keys are hidden.
which-key-show-transient-mapsShow keymaps created by ‘set-transient-map’ when applicable.
which-key-side-window-locationLocation of which-key popup when ‘which-key-popup-type’ is side-window.
which-key-side-window-max-heightMaximum height of which-key popup when type is side-window.
which-key-side-window-max-widthMaximum width of which-key popup when type is side-window.
which-key-side-window-slotThe ‘slot’ to use for ‘display-buffer-in-side-window’.
which-key-sort-orderOrder in which the key bindings are sorted.
which-key-sort-uppercase-firstIf non-nil, uppercase comes before lowercase in sorting.
which-key-special-keysKeys which will be truncated to their first character.
which-key-this-command-keys-functionFunction used to retrieve current key sequence.
which-key-unicode-correctionCorrection for wide unicode characters.
which-key-use-C-h-commandsUse C-h (‘help-char’) for paging if non-nil.

Defined functions (149)

copy-which-key--pages(ARG)
make-which-key--pages
make-which-key--pages--cmacro
which-key--any-match-p(REGEXPS STRING)
which-key--butlast-string(STR)
which-key--char-enlarged-p(&optional FRAME)
which-key--char-exact-p(&optional FRAME)
which-key--char-reduced-p(&optional FRAME)
which-key--compute-binding(BINDING)
which-key--create-buffer-and-show(&optional PREFIX-KEYS FROM-KEYMAP FILTER PREFIX-TITLE)
which-key--create-pages(KEYS &optional PREFIX-KEYS PREFIX-TITLE)
which-key--create-pages-1(KEYS AVAILABLE-LINES AVAILABLE-WIDTH &optional MIN-LINES VERTICAL)
which-key--current-key-list(&optional KEY-STR)
which-key--current-key-string(&optional KEY-STR)
which-key--debug-message(&rest MSG)
which-key--echo(TEXT)
which-key--evil-operator-filter(BINDING)
which-key--extract-key(KEY-STR)
which-key--fit-buffer-to-window-horizontally(&optional WINDOW &rest PARAMS)
which-key--format-and-replace(UNFORMATTED &optional PRESERVE-FULL-KEY)
which-key--frame-max-dimensions()
which-key--frame-size-changed-p()
which-key--full-prefix(PREFIX-KEYS &optional -PREFIX-ARG DONT-PROP-KEYS)
which-key--get-bindings(&optional PREFIX KEYMAP FILTER RECURSIVE)
which-key--get-current-bindings(&optional PREFIX FILTER)
which-key--get-keymap-bindings(KEYMAP &optional START PREFIX FILTER ALL EVIL)
which-key--get-keymap-bindings-1(KEYMAP START &optional PREFIX FILTER ALL IGNORE-COMMANDS)
which-key--get-menu-item-binding(DEF)
which-key--get-popup-map()
which-key--god-mode-lookup-command-advice(ORIG-FUN ARG1 &rest ARGS)
which-key--god-mode-this-command-keys()
which-key--group-p(DESCRIPTION)
which-key--height-or-percentage-to-height(HEIGHT-OR-PERCENTAGE)
which-key--hide-buffer-frame()
which-key--hide-buffer-side-window()
which-key--hide-popup()
which-key--hide-popup-ignore-command()
which-key--hide-popup-on-frame-size-change(&optional _)
which-key--highlight-face(DESCRIPTION)
which-key--init-buffer()
which-key--join-columns(COLUMNS)
which-key--key-description<(A B &optional ALPHA)
which-key--lighter-restore()
which-key--lighter-status()
which-key--list-to-pages(KEYS AVL-LINES AVL-WIDTH)
which-key--local-binding-p(KEYDESC)
which-key--map-binding-p(MAP KEYDESC)
which-key--match-replacement(KEY-BINDING REPLACEMENT)
which-key--max-len(KEYS INDEX &optional INITIAL-VALUE)
which-key--maybe-add-docstring(CURRENT ORIGINAL)
which-key--maybe-get-prefix-title(KEYS)
which-key--maybe-replace(KEY-BINDING)
which-key--minibuffer-max-dimensions()
which-key--next-page-hint(PREFIX-KEYS)
which-key--normalize-columns(COLUMNS)
which-key--pad-column(COL-KEYS AVL-WIDTH)
which-key--pages-height(which-key--pages-height X)
which-key--pages-height--inliner(INLINE--FORM X)
which-key--pages-keys/page(which-key--pages-keys/page X)
which-key--pages-keys/page--inliner(INLINE--FORM X)
which-key--pages-num-pages(which-key--pages-num-pages X)
which-key--pages-num-pages--inliner(INLINE--FORM X)
which-key--pages-p(X)
which-key--pages-p--inliner(INLINE--FORM X)
which-key--pages-page-nums(which-key--pages-page-nums X)
which-key--pages-page-nums--inliner(INLINE--FORM X)
which-key--pages-pages(which-key--pages-pages X)
which-key--pages-pages--inliner(INLINE--FORM X)
which-key--pages-prefix(which-key--pages-prefix X)
which-key--pages-prefix--inliner(INLINE--FORM X)
which-key--pages-prefix-title(which-key--pages-prefix-title X)
which-key--pages-prefix-title--inliner(INLINE--FORM X)
which-key--pages-set-current-page(PAGES-OBJ N)
which-key--pages-total-keys(which-key--pages-total-keys X)
which-key--pages-total-keys--inliner(INLINE--FORM X)
which-key--pages-widths(which-key--pages-widths X)
which-key--pages-widths--inliner(INLINE--FORM X)
which-key--partition-list(N LIST)
which-key--popup-max-dimensions()
which-key--process-page(PAGES-OBJ)
which-key--propertize(STRING &rest PROPERTIES)
which-key--propertize-description(DESCRIPTION GROUP LOCAL HL-FACE &optional ORIGINAL-DESCRIPTION)
which-key--propertize-key(KEY)
which-key--read-keymap()
which-key--replace-in-binding(KEY-BINDING REPL)
which-key--replace-in-repl-list-many(KEY-BINDING REPLS)
which-key--replace-in-repl-list-once(KEY-BINDING REPLS)
which-key--rotate(LIST N)
which-key--safe-lookup-key(KEYMAP KEY)
which-key--safe-lookup-key-description(KEYMAP KEY)
which-key--setup-echo-keystrokes()
which-key--show-buffer-frame(ACT-POPUP-DIM)
which-key--show-buffer-new-frame(FRAME-HEIGHT FRAME-WIDTH)
which-key--show-buffer-reuse-frame(FRAME-HEIGHT FRAME-WIDTH)
which-key--show-buffer-side-window(ACT-POPUP-DIM)
which-key--show-keymap(KEYMAP-NAME KEYMAP &optional PRIOR-ARGS ALL NO-PAGING FILTER)
which-key--show-page(&optional N)
which-key--show-popup(ACT-POPUP-DIM)
which-key--side-window-max-dimensions()
which-key--start-paging-timer()
which-key--start-timer(&optional DELAY SECONDARY)
which-key--stop-timer()
which-key--string-width(MAYBE-STRING)
which-key--string<(A B &optional ALPHA)
which-key--text-width-to-total(TEXT-WIDTH)
which-key--this-command-keys()
which-key--total-width-to-text(TOTAL-WIDTH)
which-key--truncate-description(DESC AVL-WIDTH)
which-key--try-2-side-windows(BINDINGS PREFIX-KEYS PREFIX-TITLE LOC1 LOC2 &rest IGNORE)
which-key--update()
which-key--width-or-percentage-to-width(WIDTH-OR-PERCENTAGE)
which-key-C-h-dispatch()
which-key-abort(&optional _)
which-key-add-key-based-replacements(KEY-SEQUENCE REPLACEMENT &rest MORE)
which-key-add-keymap-based-replacements(KEYMAP KEY REPLACEMENT &rest MORE)
which-key-add-major-mode-key-based-replacements(MODE KEY-SEQUENCE REPLACEMENT &rest MORE)
which-key-define-key-recursively(MAP KEY DEF &optional AT-ROOT)
which-key-description-order(ACONS BCONS)
which-key-digit-argument(KEY)
which-key-dump-bindings(PREFIX BUFFER-NAME)
which-key-enable-god-mode-support(&optional DISABLE)
which-key-key-order(ACONS BCONS)
which-key-key-order-alpha(ACONS BCONS)
which-key-local-then-key-order(ACONS BCONS)
which-key-mode(&optional ARG)
which-key-prefix-then-key-order(ACONS BCONS)
which-key-prefix-then-key-order-reverse(ACONS BCONS)
which-key-reload-key-sequence(&optional KEY-SEQ)
which-key-remove-default-unicode-chars()
which-key-setup-minibuffer()
which-key-setup-side-window-bottom()
which-key-setup-side-window-right()
which-key-setup-side-window-right-bottom()
which-key-show-full-keymap(KEYMAP)
which-key-show-full-major-mode()
which-key-show-full-minor-mode-keymap()
which-key-show-keymap(KEYMAP &optional NO-PAGING)
which-key-show-major-mode(&optional ALL)
which-key-show-minor-mode-keymap(&optional ALL)
which-key-show-next-page-cycle(&optional _)
which-key-show-next-page-no-cycle()
which-key-show-previous-page-cycle(&optional _)
which-key-show-previous-page-no-cycle()
which-key-show-standard-help(&optional _)
which-key-show-top-level(&optional _)
which-key-toggle-docstrings(&optional _)
which-key-turn-page(DELTA)
which-key-undo(&optional _)
which-key-undo-key(&optional _)

Defined faces (8)

which-key-command-description-faceFace for the key description when it is a command.
which-key-docstring-faceFace for docstrings.
which-key-group-description-faceFace for the key description when it is a group or prefix.
which-key-highlighted-command-faceDefault face for highlighted command descriptions. A command is highlighted, when it matches a string in ‘which-key-highlighted-command-list’.
which-key-local-map-description-faceFace for the key description when it is found in ‘current-local-map’.
which-key-note-faceFace for notes or hints occasionally provided.
which-key-separator-faceFace for the separator (default separator is an arrow).
which-key-special-key-faceFace for special keys (SPC, TAB, RET).