doc: popup_user_mappings

folke · Nov 27, 2022 · 5d36f47 · 5d36f47
1 parent e3798b8
commit 5d36f47
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -112,6 +112,9 @@ WhichKey comes with the following defaults:
     scroll_down = '<c-d>', -- binding to scroll down inside the popup
     scroll_up = '<c-u>', -- binding to scroll up inside the popup
   },
+  -- binding key to function inside the popup. The user-defined function accepts two parameter `(keys, mode)`,
+  -- in which `keys` is the keys bring up the popup, `mode` is the current vim mode.
+  popup_user_mappings = {},
   window = {
     border = "none", -- none, single, double, shadow
     position = "bottom", -- bottom, top

diff --git a/doc/which-key.txt b/doc/which-key.txt
@@ -148,6 +148,9 @@ WhichKey comes with the following defaults:
         scroll_down = '<c-d>', -- binding to scroll down inside the popup
         scroll_up = '<c-u>', -- binding to scroll up inside the popup
       },
+      -- binding key to function inside the popup. The user-defined function accepts two parameter `(keys, mode)`,
+      -- in which `keys` is the keys bring up the popup, `mode` is the current vim mode.
+      popup_user_mappings = {},
       window = {
         border = "none", -- none, single, double, shadow
         position = "bottom", -- bottom, top

diff --git a/lua/which-key/config.lua b/lua/which-key/config.lua
@@ -45,6 +45,8 @@ local defaults = {
     scroll_down = "<c-d>", -- binding to scroll down inside the popup
     scroll_up = "<c-u>", -- binding to scroll up inside the popup
   },
+  -- binding key to function inside the popup. The user-defined function accepts two parameter `(keys, mode)`,
+  -- in which `keys` is the keys bring up the popup, `mode` is the current vim mode.
   popup_user_mappings = {},
   window = {
     border = "none", -- none, single, double, shadow