Very restrictive triggers list

[mufasachan]

Hello,

In the version 2, I only allowed my Leader key, <Space>, as a trigger. It was simple and I could set triggers = { "<Leader>", } in my opts.

I could not achieve the same thing with the v3. First the triggers is not documented in the help, so I am a bit unsure what I should set there. The former value does not work. I looked a bit into the code I tried to find where triggers is used and I guessed it is used in the triggers.lua when the state is updated or something? Anyway, I could not make this simple work.

In the opts I disable all plugins, all false value. But my buffer mapping was still there like g. I read the code a little bit and maybe the functions needs_trigger decide if a node, a key typed?, should rely on a triggers and in the case make use of the triggers. But, I feel like the trigger in opts is just there to add, not remove, existing triggers? That's my conclusion after looking at the attach method of Mode.

This discussion is not about asking for help. In the opts I set disable.trigger function that only allow my leader key, "".

I am writing this for two things:

1. Is there a more direct way to set a single trigger?*
2. Someone can point me to resources to better understand the code? Or Lua plugin in general. I guess my lack of understanding of wk is probably due to my lack of lua skills in general and lack of knowledge of (neo)vim. I would like to improve.

*: Progressively I will add more triggers. I love the plugin, I think it can be very comfortable to work with.

Edit: Add my solution, with lazy table plugin definition. Interesting enouch, "<Space>" works and "<Leader>". My leader is the space character.

---Disable unwanted triggers
---@param ctx {keys: string, mode: string, plugin?: string}
---@return boolean
local function disable_triggers(ctx)
	return (ctx.mode ~= "n") or (string.len(ctx.keys) ~= 7) or (ctx.keys:sub(1, 7) ~= "<Space>")
end
plugin.opts = {
	disable = { trigger = disable_triggers },
}

[folke]

Just set opts.triggers = false and disable all the modes. Then call which-key manually for your leader

[mufasachan]

Thanks for the tips. I tried your approach here the lazy configuration with this:

plugin.opts = {
	triggers = false,
	modes = {
		n = true,
		i = false,
		x = false,
		s = false,
		o = false,
		t = false,
		c = false,
	},
	plugins = { registers = false, marks = false },
}

plugin.config = function(_, opts)
	local wk = require("which-key")

	local show = function() return wk.show({ mode = "n", keys = "<Leader>" }) end
	vim.api.nvim_set_keymap("n", "<Leader>", "<NOP>", { callback = show })

	wk.setup(opts)
end

I need modes.normal to be true, else it does not work. Therefore, I added the plugins part. If modes.normal=false then I have the message error message of show method.

It works this way, but the menu has a weird behaviour: if I type something that is not in the menu, the menu is frozen, <C-c> is the only solution. Plus sometimes it opens the root menu? I will post an issue later, and do a proper minimal reproduction of the behaviour, if you validate that my lua is OK. Maybe I did not follow your instructions clearly.

[folke]

That freeze is because you map <leader> yourself and wk doesn't know it's a trigger.
Nothing I can do about that, so please don't open an issue.

There's probably ways to make it work, but I'm not going to support this.

You could look in making opts.trigger a function instead that only allows a trigger on <leader>.
That way wk will know it's a trigger and you won't have a loop.

[mufasachan]

Thanks you very much for your time and your explanations!

[folke]

I just made a bunch of changes for configuring triggers.
See https://github.com/folke/which-key.nvim?tab=readme-ov-file#-triggers

[mufasachan]

Awesome, thanks! I was reading the code to see how triggers can be adapted, your solution is nice.