feature: Excluding a mapped key

[Myzel394]

Did you check the docs?

• [X] I have read all the which-key.nvim docs

Is your feature request related to a problem? Please describe.

Given the following maps:

for i = 1, 10 do
    vim.keymap.set("n", "<leader>" .. i, function() ui.nav_file(i) end)
end

it's obvious for me what <leader> + number does. I'd like to be able to exclude them from showing up in which-key.

Describe the solution you'd like

Add an option to make fields hidden.

Describe alternatives you've considered

I tried to add them to hidden using:

hidden = { "<silent>", "<cmd>", "<Cmd>", "<CR>", "^:", "^ ", "^call ", "^lua ", "<leader>1", "^<leader>1", ... plus the other numbers }

and also tried to create a custom mapping as instructed in https://github.com/folke/which-key.nvim#%EF%B8%8F-mappings but the key was still shown.

Additional context

No response

[gagiD]

+1

[arpangreat]

If you are using custom mappings using which key itself, just pass which_key_ignore label in the name/desc of the command , it's in the mappings section of the readme.

[gagiD]

@arpangreat Thank you.

For the record, this works for me:

local opts = { noremap = true, silent = true, desc = "which_key_ignore" }

vim.api.nvim_set_keymap("n", "<leader>1", ":BufferLineGoToBuffer 1<CR>", opts)

[github-actions[bot]]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.