folke/which-key.nvim
Which Key.nvim
which-key.nvim is a keybinding discovery menu and command palette for Neovim. It serves as a configuration tool to organize complex keymap hierarchies and a visual utility for browsing editor marks, registers, and spelling suggestions through a compact popup interface.
The plugin differentiates itself by organizing shortcuts into nested groups with custom labels and icons, reducing the need to memorize long key sequences. It includes built-in help presets for native editor operators and motions, and supports dynamic key mapping where descriptions are evaluated at runtime.
The system covers wide-ranging capability areas including editor state visualization, interface customization for popup aesthetics, and keybinding conflict auditing. It also provides controls for trigger timing and visibility filtering to manage how and when the discovery menu appears.
Features
- Keybinding Discovery Systems - Shows a popup menu of available commands and their descriptions as a user types to help remember complex shortcuts.
- Keybinding Discovery Menus - Implements a popup interface that displays available keybindings and descriptions as the user types.
- Hierarchical Keybinding Groups - Organizes related commands into named groups that expand to reveal further options.
- Nested Command Structures - Organizes keybindings into a hierarchical tree structure where each node represents a prefix for subsequent commands.
- Command Palettes - Provides an interactive menu for discovering and triggering nested groups of shortcuts and editor motions.
- Mapping Groups - Allows creating organized groups of keybindings with custom labels, icons, and conditions for the suggestion menu.
- Neovim Plugins - Organizes large sets of custom keybindings into nested groups with labels and icons for better structure and clarity.
- Editor State Visualizers - Quickly browses registers, marks, and spelling suggestions through a compact popup menu.
- Register Content Inspections - Lists the contents of buffer-local and global registers within a popup menu.
- Command Metadata Presets - Loads hard-coded metadata sets that map standard editor motions and operators to user-friendly descriptions.
- Dynamic Binding Resolution - Evaluates function-based descriptions and visibility filters at runtime to update the discovery menu content.
- Keybinding Presets - Allows loading pre-defined sets of keybindings for common editor behaviors or specific external tool integrations.
- Keybinding Help Presets - Provides pre-configured descriptions for native editor operators, motions, and window navigation.
- Conflict Detection - Identifies duplicate or overlapping keymaps via health checks to detect configuration errors.
- Scoped Mapping Registries - Maintains separate mapping stores for editor-wide commands and buffer-specific bindings to ensure correct context resolution.
- Cognitive Load Reduction - Reduces the cognitive load of remembering key-sequences by providing real-time hints and interactive discovery menus.
- Dynamic Command Mappings - Supports generating keybindings on the fly using functions to determine the mapping or its description at display time.
- Buffer-Local Configuration - Handles keybindings specific to a single buffer, including custom sorting and local leader mappings.
- Event-Driven Popup Triggers - Listens for specific keystrokes and timers to display an overlay menu after a defined period of inactivity.
- Editor State Visualizations - Displays a list of all buffer-local and global marks in a compact popup.
- Floating Window Components - Creates temporary floating windows with custom borders and alignments to present a non-intrusive discovery menu.
- Keybinding Label Customization - Enables overriding default display names, descriptions, and icons for specific keybindings to improve clarity.
- Popup Styling - Configures the layout, sorting logic, color schemes, and icon sets for the keybinding popup.
- Command Menu Customization - Modifies the visual style and behavior of command menus to match a specific editor theme or layout preference.
- Keybinding Management - Displays available keybindings in a popup.
