feat: allow disabling any trigger

folke · Jul 12, 2024 · 94b7951 · 94b7951
1 parent b8fb714
commit 94b7951
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/lua/which-key/buf.lua b/lua/which-key/buf.lua
@@ -84,12 +84,16 @@ function Mode:_attach(node)
   if not self.buf:valid() then
     return
   end
-  self.triggers[node.keys] = node
-  local delay = require("which-key.state").delay({
+  local ctx = {
     mode = self.mode,
     keys = node.keys,
     plugin = node.plugin,
-  })
+  }
+  if Config.disable.trigger(ctx) then
+    return
+  end
+  self.triggers[node.keys] = node
+  local delay = require("which-key.state").delay(ctx)
   local waited = vim.o.timeout and delay >= vim.o.timeoutlen and vim.o.timeoutlen or 0
   vim.keymap.set(self.mode, node.keys, function()
     require("which-key.state").start({

diff --git a/lua/which-key/config.lua b/lua/which-key/config.lua
@@ -135,6 +135,11 @@ local defaults = {
     -- disable WhichKey for certain buf types and file types.
     ft = {},
     bt = {},
+    -- disable a trigger for a certain context by returning true
+    ---@type fun(ctx: { keys: string, mode: string, plugin?: string }):boolean?
+    trigger = function(ctx)
+      return false
+    end,
   },
 }