Skip to content

Releases: folke/which-key.nvim

v3.8.0

17 Jul 21:34
2af3dc5
Compare
Choose a tag to compare

3.8.0 (2024-07-17)

Features

  • mappings: added health check for invalid modes (640724a)

Bug Fixes

  • buf: never create proxy/plugin mappings when a keymap exists. Fixes #738 (b4c4e36)
  • registers: use x instead of v (#742) (5c3b3e8)
  • state: schedule redraw. Fixes #740 (09f21a1)
  • triggers: allow overriding keymaps with empty rhs or <Nop>. Fixes #748 (843a93f)
  • triggers: make sure no keymaps exists for triggers (e8b454f)
  • typo: replace 'exras' for 'extras' in README. (#745) (af48cdc)

v3.7.0

17 Jul 10:49
df77add
Compare
Choose a tag to compare

3.7.0 (2024-07-17)

Features

  • added expand property to create dynamic mappings. An example for buf and win is included (02f6e6f)
  • proxy mappings (c3cfc2b)
  • state: allow defering on certain operators. Closes #733 (984d930)

Bug Fixes

  • buf: create triggers for xo anyway. Fixes #728 (96b2e93)
  • icons: added frontier pattern for git. Fixes #727 (bb4e82b)
  • state: dont popup when switching between v and V mode. Fixes #729 (8ddb527)
  • view: always show a group as a group (96a9eb3)
  • view: empty icons (e2cacc6)

v3.6.0

16 Jul 16:41
a1770d2
Compare
Choose a tag to compare

3.6.0 (2024-07-16)

Features

  • added icons for <D mappings (aaf71ab)
  • added option to disable all mapping icons. Fixes #721 (33f6ac0)
  • make which-key work without setup or calling add/register (9ca5f4a)
  • presets: added some missing mappings (6e1b3f2)
  • state: improve trigger/mode logic. Fixes #715 (3617e47)

Bug Fixes

  • config: replacement for plug mappings (495f9d9)
  • icons: get icons from parent nodes when needed (3f0a7ed)
  • icons: use nerdfont symbol for BS. Fixes #722 (18c1ff5)
  • mode: never create triggers for xo mode (15d3a70)
  • presets: motions in normal mode (e2ffc26)
  • tmp fix for op mode (91641e2)
  • view: fix format for keymaps with 3+ keys (#723) (0db7896)

v3.5.0

15 Jul 21:28
b55a568
Compare
Choose a tag to compare

3.5.0 (2024-07-15)

Features

  • api: using wk.show() always assumes you want to see the group, and not the actual mapping in case of overlap. Fixes #714 (f5067d2)

Bug Fixes

  • state: attach on BufNew as well. Fixes #681 (0f58176)
  • state: make sure mode always exists even when not safe. See #681 (7915964)

Performance Improvements

  • plugin: only expand plugins when needed (1fcfc72)
  • view: set buf/win opts with eventignore (e81e55b)

v3.4.0

15 Jul 13:48
6e5b5b0
Compare
Choose a tag to compare

3.4.0 (2024-07-15)

Features

  • added icons for function keys (9222280)
  • mode: allow certain modes to start hidden and only show after keypress. See #690 (b4fa48f)
  • presets: added gw (09b80a6)
  • presets: better padding defaults for helix preset (4c36b9b)
  • presets: increase default height for helix (df0ad20)
  • simplified/documented/fixed mappings sorting. Closes #694 (eb73f7c)
  • state: skip mouse keys in debug (5f85b77)
  • ui: show keys/help in an overlay and added scrolling hint (50b2c43)
  • view: get parent icon if possible (b9de927)

Bug Fixes

  • buf: always detach " when executing keys. Fixes #689 (d36f722)
  • config: set expand=0 by default. Fixes #693 (89434aa)
  • config: warn when deprecated config options were used. Fixes #696 (81413ef)
  • health: move deprecated option check to health (af7a30f)
  • mappings: allow creating keymaps without desc. Fixes #695 (c442aaa)
  • plugins: add existing keymaps to plugin view. Fixes #681 (26f6fd2)
  • presets: don't override title setting for classic. See #649 (9a53c1f)
  • presets: shorter descriptions (20600e4)
  • state: always do full update on BufReadPost since buffer-local keymaps would be deleted. Fixes #709 (6068887)
  • state: don't show when coming from cmdline mode. Fixes #692 (8cba66b)
  • state: honor timeoutlen and nowait. Fixes #648. Closes #697 (80f20ee)
  • state: properly disable which-key when recording macros. Fixes #702 (b506275)
  • state: scrolling (dce9167)
  • tree: rawget for existing plugin node children (c77cda8)
  • util: when no clipboard provider exists, use the " register as default. Fixes #687 (d077a3f)
  • view: disable footer on Neovim < 0.10 (6d544a4)
  • view: ensure highlights get set for title padding (#684) (2e4f7af)
  • view: hide existing title/footer when no trail (4f589a1)
  • view: include group keymaps in expand results. See #682 (39e703c)
  • view: overlap protection should keep at least 4 lines (0d89475)
  • view: padding & column spacing. Fixes #704 (11eec49)
  • view: spacing when more than one box (89568f3)
  • view: special handling of &lt;NL&gt;/<C-J>. Fixes #706 (f8c91b2)

v3.3.0

14 Jul 05:51
4d5b895
Compare
Choose a tag to compare

3.3.0 (2024-07-14)

Features

  • expand: allow expand to be a function. Closes #670 (dfaa10c)
  • mappings: mapping desc and icon can now be a function that is evaluated when which-key is show. Fixes #666 (c634af1)
  • mappings: opts.filter to exclude certain mappings from showing up in which-key. (763ea00)
  • view: add operator to trail in op mode (5a6eaaa)
  • view: when in visual mode, propagate esc. See #656 (30ef44a)

Bug Fixes

  • default preset (38987d3)
  • mappings: don't show &lt;SNR&gt; mappings (d700244)
  • presets: max 1 column in helix mode. Fixes #665 (b2a6910)
  • presets: shorter descriptions (9a73d6a)
  • state: cooldown till next tick when not safe to open which-key. Fixes #672 (bdf3b27)
  • util: nt mode should map to n (969afc9)
  • view: set nowrap for the which-key window (6e1c098)
  • view: set winhl groups. Fixes #661 (baff8ea)

v3.2.0

13 Jul 16:23
b695114
Compare
Choose a tag to compare

3.2.0 (2024-07-13)

Features

  • added opts.debug that writes to wk.log in the current directory (c23df71)
  • hydra mode. will document later (65f2e72)
  • icons: add telescope icon (#643) (fca3d9e)

Bug Fixes

  • layout stuff (7423096)
  • mappings: always use mapping even when it's creating a keymap. Fixes #637 (2d744cb)
  • mappings: make replace_keycodes default to false in v1 spec (6ec0a1e)
  • state: dont start which-key during dot repeat. Fixes #636 (5971ecd)
  • state: dont start which-key more than once during the same tick in xo mode. Fixes #635 (0218fce)
  • state: dont start wk when chars are pending. Fixes #658. Fixes #655. Fixes #648 (877ce16)
  • state: only hide on focus lost when still hidden after 1s. Fixes #638 (649a51b)
  • types: spec field types (#645) (c6ffb1c)
  • util: set local window opts for notify. Fixes #641 (63f2112)
  • view: check for real overlap instead of just row overlap. See #649 (0427e91)
  • view: disable folds. Fixes #99 (6860e3b)

v3.1.0

12 Jul 20:54
Compare
Choose a tag to compare

3.1.0 (2024-07-12)

Features

  • allow disabling any trigger (94b7951)

Bug Fixes

  • added support for vim.loop (54db192)
  • automatically do setup if setup wasn't called within 500ms. Fixes #630 (632ad41)
  • buf: buffer-local mappings were broken (not keymaps). Fixes #629 (58d7f82)
  • colors: compat with older Neovim vesions. Fixes #631 (4516dc9)

v3.0.0

12 Jul 19:25
Compare
Choose a tag to compare

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 &lt;esc&gt; 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)

v2.1.0

06 Jun 15:08
0539da0
Compare
Choose a tag to compare

2.1.0 (2024-06-06)

Features

  • presets: add descriptions for fold deletion (#504) (53b6085)

Bug Fixes