Variable: which-key-replacement-alist

which-key-replacement-alist is a customizable variable defined in which-key.el.gz.

Value

(((nil . "which-key-show-next-page-no-cycle") nil . "wk next pg")
 (("<\\([[:alnum:]-]+\\)>") "\\1"))

Documentation

ALIST for manipulating display of binding descriptions.

Each element of the list is a nested cons cell with the format

(MATCH CONS . REPLACEMENT).

The MATCH CONS determines when a replacement should occur and REPLACEMENT determines how the replacement should occur. Each may have the format (KEY REGEXP . BINDING REGEXP). For the replacement to apply the key binding must match both the KEY REGEXP and the BINDING REGEXP. A value of nil in either position can be used to match every possibility. The replacement is performed by using replace-regexp-in-string on the KEY REGEXP from the MATCH CONS and REPLACEMENT when it is a cons cell, and then similarly for the BINDING REGEXP. A nil value in the BINDING REGEXP position cancels the replacement. For example, the entry

((nil . "Prefix Command") . (nil . "prefix"))

matches any binding with the descriptions "Prefix Command" and replaces the description with "prefix", ignoring the corresponding key.

REPLACEMENT may also be a function taking a cons cell
(KEY . BINDING) and producing a new corresponding cons cell.

If REPLACEMENT is anything other than a cons cell (and non nil) the key binding is ignored by which-key.

Finally, you can multiple replacements to occur for a given key binding by setting which-key-allow-multiple-replacements to a non-nil value.

This variable was added, or its default value changed, in which-key version 1.0.

Source Code

;; Defined in /usr/src/emacs/lisp/which-key.el.gz
(defcustom which-key-replacement-alist
  `(((nil . "which-key-show-next-page-no-cycle") . (nil . "wk next pg"))
    ,@(unless which-key-dont-use-unicode
        '((("<left>") . ("←"))
          (("<right>") . ("→"))))
    (("<\\([[:alnum:]-]+\\)>") . ("\\1")))
  "ALIST for manipulating display of binding descriptions.
Each element of the list is a nested cons cell with the format

\(MATCH CONS . REPLACEMENT\).

The MATCH CONS determines when a replacement should occur and
REPLACEMENT determines how the replacement should occur.  Each may
have the format \(KEY REGEXP . BINDING REGEXP\).  For the
replacement to apply the key binding must match both the KEY
REGEXP and the BINDING REGEXP.  A value of nil in either position
can be used to match every possibility.  The replacement is
performed by using `replace-regexp-in-string' on the KEY REGEXP
from the MATCH CONS and REPLACEMENT when it is a cons cell, and
then similarly for the BINDING REGEXP.  A nil value in the BINDING
REGEXP position cancels the replacement.  For example, the entry

\(\(nil . \"Prefix Command\"\) . \(nil . \"prefix\"\)\)

matches any binding with the descriptions \"Prefix Command\" and
replaces the description with \"prefix\", ignoring the
corresponding key.

REPLACEMENT may also be a function taking a cons cell
\(KEY . BINDING\) and producing a new corresponding cons cell.

If REPLACEMENT is anything other than a cons cell \(and non nil\)
the key binding is ignored by which-key.

Finally, you can multiple replacements to occur for a given key
binding by setting `which-key-allow-multiple-replacements' to a
non-nil value."
  :type '(alist :key-type (cons (choice regexp (const nil))
                                (choice regexp (const nil)))
                :value-type (cons (choice string (const nil))
                                  (choice string (const nil))))
  :package-version '(which-key . "1.0") :version "30.1")