v3.0.0

3.0.0 (2024-07-12)

⚠ BREAKING CHANGES

• v3 release

Features

• added health check back with better wording on what actually gets checked (97e6e41)
• added WhichKey command (7c12ab9)
• automatically use nowait based on delay and timeoutlen (110ed72)
• bring config back and create mappings when needed (add7ab9)
• buffer-local sort & refactor API (14309d0)
• close which-key on FocusLost (aa99460)
• config, and presets (541989d)
• expand groups with less than n mappings. Closes #374. Fixes #90. Closes #208 (5caf057)
• fancy key icons (e4d0134)
• fix hidden and empty groups (afc4aa9)
• health: duplicate mappings check (4762e06)
• health: icon providers & overlapping keys (dcbf29a)
• initial rewrite (eb3ad2e)
• keep track of virtual mappings (4537d3e)
• key/desc replacements (cf34ffe)
• layout (347288a)
• manual sorting. Closes #131, Closes #362, Closes #264 (c2daf9d)
• mappings: added support for lazy.nvim style mappings (6f7a945)
• mappings: added support for setting custom icons from the spec (951ae7a)
• new spec and migration recommendation for health (41374bc)
• option to disable icon colors (79c8ac8)
• option to disable notify (4cc46ff)
• play nice with macros (1abc2bf)
• plugins partially working again (b925b31)
• registers: show non-printable with keytrans (1832197)
• spec parser rewrite & proper typings (07065fe)
• state management (e2ee1fa)
• state management (e6beb88)
• title trail (aef2e53)
• ui: added scrolling (5f1ab35)
• ui: keymap icons (21d7108)
• ui: sorters (ffeea79)
• update ui when new mappings become available (a8f66f5)
• v3 release (da258a8)
• view: nerd font icons for cmd keys (2787dbd)

Bug Fixes

• api: show view immediately when opened through the API (b0e0af0)
• autmatically blacklist all single key hooks except for z and g (87c5a4b)
• icons: check that mini icons hl groups exist in the current colorscheme. If not use which-key default groups (2336350)
• icons: proper icons check (2eaed99)
• keys: delete nop keymaps with a description (ccf0276)
• layout: display vs multibyte ellipsis (0442a73)
• layout: empty columns (600881a)
• op-mode, count and reg (e4d54d1)
• pcall keymap.del (e47ee13)
• plugin actions & spelling (e7da411)
• presets (bcf52ba)
• readme (5fe6c91)
• respect mappings with <esc> and close on cursor moved (22deda5)
• set check debounce to 50 (754bcc7)
• state: dont return or autocmd will cancel (9a77986)
• state: keyboard interrupts (1ed9182)
• state: make sure the buffer mode exists when changing modes (df64366)
• stuff (f67eb19)
• tree: check for which_key_ignore in existing keymaps (f17d78b)
• ui: box height (528fc43)
• ui: make sure the which-key window never overlaps the user's cursor position (1bb30a7)
• ui: scroll and topline=1 on refresh (28b648d)
• which_key_ignore (ab5ffa8)
• which-key ignore and cleanup (aeae826)