GNU ELPA - keymap-popup

Requires Emacs 29.1+. No external dependencies.

(add-to-list 'load-path "/path/to/keymap-popup")
(require 'keymap-popup)

Or with use-package:

(use-package keymap-popup
  :ensure t)

(keymap-popup-define my-commands-map
  "My commands."
  :group "Edit"
  "c" ("Comment" comment-dwim)
  "r" ("Rename" rename-file)
  :group "View"
  "g" ("Refresh" revert-buffer)
  "q" ("Quit" quit-window))

;; Use as a normal keymap:
(keymap-set some-mode-map "C-c m" my-commands-map)

;; Or show the popup directly:
(keymap-popup my-commands-map)

Press h in the keymap to open the popup. Press q to dismiss.

• :switch – buffer-local toggle with [on]/[off] display
• :keymap – sub-menu with stack navigation (q / C-g pops back)
• :stay-open – command executes without dismissing the popup
• :inapt-if – grays out and blocks entries based on a predicate
• :c-u – prefix argument mode (C-u highlights eligible entries)
• :if – conditionally hide entries
• :group / :row – column layout
• Dynamic descriptions via lambdas
• keymap-popup-annotate – add popup descriptions to existing keymaps
• keymap-popup-attach – attach descriptions built from runtime data

Full usage – special bindings, sub-menus, annotating keymaps like dired-mode-map, display backends, customization – lives in the user manual, also available as an Info manual (make doc).

The repository flake pins Nixpkgs and provides Emacs, GNU Make, Texinfo, and package-lint. Public Make targets enter the development shell automatically when Nix is available:

make dev
make doc

Enter the same environment manually with nix develop. Run the sandboxed package build, tests, lint checks, and manual build with:

nix flake check

Set USE_NIX=0 to run a Make target directly in the current environment.