Refresh generated neovim config
This commit is contained in:
@ -1,32 +1,37 @@
|
||||
# 💥 Which Key
|
||||
|
||||
**WhichKey** is a lua plugin for Neovim 0.5 that displays a popup with possible key bindings of
|
||||
the command you started typing. Heavily inspired by the original [emacs-which-key](https://github.com/justbur/emacs-which-key) and [vim-which-key](https://github.com/liuchengxu/vim-which-key).
|
||||
**WhichKey** helps you remember your Neovim keymaps, by showing available keybindings
|
||||
in a popup as you type.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## ✨ Features
|
||||
|
||||
- for Neovim 0.7 and higher, it uses the `desc` attributes of your mappings as the default label
|
||||
- for Neovim 0.7 and higher, new mappings will be created with a `desc` attribute
|
||||
- opens a popup with suggestions to complete a key binding
|
||||
- works with any setting for [timeoutlen](https://neovim.io/doc/user/options.html#'timeoutlen'), including instantly (`timeoutlen=0`)
|
||||
- works correctly with built-in key bindings
|
||||
- works correctly with buffer-local mappings
|
||||
- extensible plugin architecture
|
||||
- built-in plugins:
|
||||
- **marks:** shows your marks when you hit one of the jump keys.
|
||||
- **registers:** shows the contents of your registers
|
||||
- **presets:** built-in key binding help for `motions`, `text-objects`, `operators`, `windows`, `nav`, `z` and `g`
|
||||
- **spelling:** spelling suggestions inside the which-key popup
|
||||
- 🔍 **Key Binding Help**: show available keybindings in a popup as you type.
|
||||
- ⌨️ **Modes**: works in normal, insert, visual, operator pending, terminal and command mode.
|
||||
Every mode can be enabled/disabled.
|
||||
- 🛠️ **Customizable Layouts**: choose from `classic`, `modern`, and `helix` presets or customize the window.
|
||||
- 🔄 **Flexible Sorting**: sort by `local`, `order`, `group`, `alphanum`, `mod`, `lower`, `icase`, `desc`, or `manual`.
|
||||
- 🎨 **Formatting**: customizable key labels and descriptions
|
||||
- 🖼️ **Icons**: integrates with [mini.icons](https://github.com/echasnovski/mini.icons) and [nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons)
|
||||
- ⏱️ **Delay**: delay is independent of `timeoutlen`
|
||||
- 🌐 **Plugins**: built-in plugins for marks, registers, presets, and spelling suggestions
|
||||
- 🚀 **Operators, Motions, Text Objects**: help for operators, motions and text objects
|
||||
- 🐙 **Hydra Mode**: keep the popup open until you hit `<esc>`
|
||||
|
||||
## ⚡️ Requirements
|
||||
|
||||
- Neovim >= 0.5.0
|
||||
- **Neovim** >= 0.9.4
|
||||
- for proper icons support:
|
||||
- [mini.icons](https://github.com/echasnovski/mini.icons) _(optional)_
|
||||
- [nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons) _(optional)_
|
||||
- a [Nerd Font](https://www.nerdfonts.com/) **_(optional)_**
|
||||
|
||||
## 📦 Installation
|
||||
|
||||
Install the plugin with your preferred package manager:
|
||||
Install the plugin with your package manager:
|
||||
|
||||
### [lazy.nvim](https://github.com/folke/lazy.nvim)
|
||||
|
||||
@ -34,51 +39,68 @@ Install the plugin with your preferred package manager:
|
||||
{
|
||||
"folke/which-key.nvim",
|
||||
event = "VeryLazy",
|
||||
init = function()
|
||||
vim.o.timeout = true
|
||||
vim.o.timeoutlen = 300
|
||||
end,
|
||||
opts = {
|
||||
-- your configuration comes here
|
||||
-- or leave it empty to use the default settings
|
||||
-- refer to the configuration section below
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### [packer](https://github.com/wbthomason/packer.nvim)
|
||||
|
||||
```lua
|
||||
-- Lua
|
||||
use {
|
||||
"folke/which-key.nvim",
|
||||
config = function()
|
||||
vim.o.timeout = true
|
||||
vim.o.timeoutlen = 300
|
||||
require("which-key").setup {
|
||||
-- your configuration comes here
|
||||
-- or leave it empty to use the default settings
|
||||
-- refer to the configuration section below
|
||||
}
|
||||
end
|
||||
},
|
||||
keys = {
|
||||
{
|
||||
"<leader>?",
|
||||
function()
|
||||
require("which-key").show({ global = false })
|
||||
end,
|
||||
desc = "Buffer Local Keymaps (which-key)",
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
## ⚙️ Configuration
|
||||
|
||||
> ❗️ IMPORTANT: the [timeout](https://neovim.io/doc/user/options.html#'timeout') when **WhichKey** opens is controlled by the vim setting [timeoutlen](https://neovim.io/doc/user/options.html#'timeoutlen').
|
||||
> Please refer to the documentation to properly set it up. Setting it to `0`, will effectively
|
||||
> always show **WhichKey** immediately, but a setting of `500` (500ms) is probably more appropriate.
|
||||
> [!important]
|
||||
> Make sure to run `:checkhealth which-key` if something isn't working properly
|
||||
|
||||
> ❗️ don't create any keymappings yourself to trigger WhichKey. Unlike with _vim-which-key_, we do this fully automatically.
|
||||
> Please remove any left-over triggers you might have from using _vim-which-key_.
|
||||
**WhichKey** is highly configurable. Expand to see the list of all the default options below.
|
||||
|
||||
> 🚑 You can run `:checkhealth which-key` to see if there's any conflicting keymaps that will prevent triggering **WhichKey**
|
||||
<details><summary>Default Options</summary>
|
||||
|
||||
WhichKey comes with the following defaults:
|
||||
<!-- config:start -->
|
||||
|
||||
```lua
|
||||
{
|
||||
---@class wk.Opts
|
||||
local defaults = {
|
||||
---@type false | "classic" | "modern" | "helix"
|
||||
preset = "classic",
|
||||
-- Delay before showing the popup. Can be a number or a function that returns a number.
|
||||
---@type number | fun(ctx: { keys: string, mode: string, plugin?: string }):number
|
||||
delay = function(ctx)
|
||||
return ctx.plugin and 0 or 200
|
||||
end,
|
||||
---@param mapping wk.Mapping
|
||||
filter = function(mapping)
|
||||
-- example to exclude mappings without a description
|
||||
-- return mapping.desc and mapping.desc ~= ""
|
||||
return true
|
||||
end,
|
||||
--- You can add any mappings here, or use `require('which-key').add()` later
|
||||
---@type wk.Spec
|
||||
spec = {},
|
||||
-- show a warning when issues were detected with your mappings
|
||||
notify = true,
|
||||
-- Which-key automatically sets up triggers for your mappings.
|
||||
-- But you can disable this and setup the triggers manually.
|
||||
-- Check the docs for more info.
|
||||
---@type wk.Spec
|
||||
triggers = {
|
||||
{ "<auto>", mode = "nxsot" },
|
||||
},
|
||||
-- Start hidden and wait for a key to be pressed before showing the popup
|
||||
-- Only used by enabled xo mapping modes.
|
||||
---@param ctx { mode: string, operator: string }
|
||||
defer = function(ctx)
|
||||
return ctx.mode == "V" or ctx.mode == "<C-V>"
|
||||
end,
|
||||
plugins = {
|
||||
marks = true, -- shows a list of your marks on ' and `
|
||||
registers = true, -- shows your registers on " in NORMAL or <C-r> in INSERT mode
|
||||
@ -98,205 +120,270 @@ WhichKey comes with the following defaults:
|
||||
g = true, -- bindings for prefixed with g
|
||||
},
|
||||
},
|
||||
-- add operators that will trigger motion and text object completion
|
||||
-- to enable all native operators, set the preset / operators plugin above
|
||||
operators = { gc = "Comments" },
|
||||
key_labels = {
|
||||
-- override the label used to display some keys. It doesn't effect WK in any other way.
|
||||
-- For example:
|
||||
-- ["<space>"] = "SPC",
|
||||
-- ["<cr>"] = "RET",
|
||||
-- ["<tab>"] = "TAB",
|
||||
---@type wk.Win.opts
|
||||
win = {
|
||||
-- don't allow the popup to overlap with the cursor
|
||||
no_overlap = true,
|
||||
-- width = 1,
|
||||
-- height = { min = 4, max = 25 },
|
||||
-- col = 0,
|
||||
-- row = math.huge,
|
||||
-- border = "none",
|
||||
padding = { 1, 2 }, -- extra window padding [top/bottom, right/left]
|
||||
title = true,
|
||||
title_pos = "center",
|
||||
zindex = 1000,
|
||||
-- Additional vim.wo and vim.bo options
|
||||
bo = {},
|
||||
wo = {
|
||||
-- winblend = 10, -- value between 0-100 0 for fully opaque and 100 for fully transparent
|
||||
},
|
||||
},
|
||||
motions = {
|
||||
count = true,
|
||||
layout = {
|
||||
width = { min = 20 }, -- min and max width of the columns
|
||||
spacing = 3, -- spacing between columns
|
||||
},
|
||||
keys = {
|
||||
scroll_down = "<c-d>", -- binding to scroll down inside the popup
|
||||
scroll_up = "<c-u>", -- binding to scroll up inside the popup
|
||||
},
|
||||
---@type (string|wk.Sorter)[]
|
||||
--- Mappings are sorted using configured sorters and natural sort of the keys
|
||||
--- Available sorters:
|
||||
--- * local: buffer-local mappings first
|
||||
--- * order: order of the items (Used by plugins like marks / registers)
|
||||
--- * group: groups last
|
||||
--- * alphanum: alpha-numerical first
|
||||
--- * mod: special modifier keys last
|
||||
--- * manual: the order the mappings were added
|
||||
--- * case: lower-case first
|
||||
sort = { "local", "order", "group", "alphanum", "mod" },
|
||||
---@type number|fun(node: wk.Node):boolean?
|
||||
expand = 0, -- expand groups when <= n mappings
|
||||
-- expand = function(node)
|
||||
-- return not node.desc -- expand all nodes without a description
|
||||
-- end,
|
||||
-- Functions/Lua Patterns for formatting the labels
|
||||
---@type table<string, ({[1]:string, [2]:string}|fun(str:string):string)[]>
|
||||
replace = {
|
||||
key = {
|
||||
function(key)
|
||||
return require("which-key.view").format(key)
|
||||
end,
|
||||
-- { "<Space>", "SPC" },
|
||||
},
|
||||
desc = {
|
||||
{ "<Plug>%(?(.*)%)?", "%1" },
|
||||
{ "^%+", "" },
|
||||
{ "<[cC]md>", "" },
|
||||
{ "<[cC][rR]>", "" },
|
||||
{ "<[sS]ilent>", "" },
|
||||
{ "^lua%s+", "" },
|
||||
{ "^call%s+", "" },
|
||||
{ "^:%s*", "" },
|
||||
},
|
||||
},
|
||||
icons = {
|
||||
breadcrumb = "»", -- symbol used in the command line area that shows your active key combo
|
||||
separator = "➜", -- symbol used between a key and it's label
|
||||
group = "+", -- symbol prepended to a group
|
||||
},
|
||||
popup_mappings = {
|
||||
scroll_down = "<c-d>", -- binding to scroll down inside the popup
|
||||
scroll_up = "<c-u>", -- binding to scroll up inside the popup
|
||||
},
|
||||
window = {
|
||||
border = "none", -- none, single, double, shadow
|
||||
position = "bottom", -- bottom, top
|
||||
margin = { 1, 0, 1, 0 }, -- extra window margin [top, right, bottom, left]. When between 0 and 1, will be treated as a percentage of the screen size.
|
||||
padding = { 1, 2, 1, 2 }, -- extra window padding [top, right, bottom, left]
|
||||
winblend = 0, -- value between 0-100 0 for fully opaque and 100 for fully transparent
|
||||
zindex = 1000, -- positive value to position WhichKey above other floating windows.
|
||||
},
|
||||
layout = {
|
||||
height = { min = 4, max = 25 }, -- min and max height of the columns
|
||||
width = { min = 20, max = 50 }, -- min and max width of the columns
|
||||
spacing = 3, -- spacing between columns
|
||||
align = "left", -- align columns left, center or right
|
||||
},
|
||||
ignore_missing = false, -- enable this to hide mappings for which you didn't specify a label
|
||||
hidden = { "<silent>", "<cmd>", "<Cmd>", "<CR>", "^:", "^ ", "^call ", "^lua " }, -- hide mapping boilerplate
|
||||
show_help = true, -- show a help message in the command line for using WhichKey
|
||||
show_keys = true, -- show the currently pressed key and its label as a message in the command line
|
||||
triggers = "auto", -- automatically setup triggers
|
||||
-- triggers = {"<leader>"} -- or specify a list manually
|
||||
-- list of triggers, where WhichKey should not wait for timeoutlen and show immediately
|
||||
triggers_nowait = {
|
||||
-- marks
|
||||
"`",
|
||||
"'",
|
||||
"g`",
|
||||
"g'",
|
||||
-- registers
|
||||
'"',
|
||||
"<c-r>",
|
||||
-- spelling
|
||||
"z=",
|
||||
},
|
||||
triggers_blacklist = {
|
||||
-- list of mode / prefixes that should never be hooked by WhichKey
|
||||
-- this is mostly relevant for keymaps that start with a native binding
|
||||
i = { "j", "k" },
|
||||
v = { "j", "k" },
|
||||
},
|
||||
-- disable the WhichKey popup for certain buf types and file types.
|
||||
-- Disabled by default for Telescope
|
||||
disable = {
|
||||
buftypes = {},
|
||||
filetypes = {},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
## 🪄 Setup
|
||||
|
||||
With the default settings, **WhichKey** will work out of the box for most builtin keybindings,
|
||||
but the real power comes from documenting and organizing your own keybindings.
|
||||
|
||||
To document and/or setup your own mappings, you need to call the `register` method
|
||||
|
||||
```lua
|
||||
local wk = require("which-key")
|
||||
wk.register(mappings, opts)
|
||||
```
|
||||
|
||||
Default options for `opts`
|
||||
|
||||
```lua
|
||||
{
|
||||
mode = "n", -- NORMAL mode
|
||||
-- prefix: use "<leader>f" for example for mapping everything related to finding files
|
||||
-- the prefix is prepended to every mapping part of `mappings`
|
||||
prefix = "",
|
||||
buffer = nil, -- Global mappings. Specify a buffer number for buffer local mappings
|
||||
silent = true, -- use `silent` when creating keymaps
|
||||
noremap = true, -- use `noremap` when creating keymaps
|
||||
nowait = false, -- use `nowait` when creating keymaps
|
||||
expr = false, -- use `expr` when creating keymaps
|
||||
}
|
||||
```
|
||||
|
||||
> ❕ When you specify a command in your mapping that starts with `<Plug>`, then we automatically set `noremap=false`, since you always want recursive keybindings in this case
|
||||
|
||||
### ⌨️ Mappings
|
||||
|
||||
> ⌨ for **Neovim 0.7** and higher, which key will use the `desc` attribute of existing mappings as the default label
|
||||
|
||||
Group names use the special `name` key in the tables. There's multiple ways to define the mappings. `wk.register` can be called multiple times from anywhere in your config files.
|
||||
|
||||
```lua
|
||||
local wk = require("which-key")
|
||||
-- As an example, we will create the following mappings:
|
||||
-- * <leader>ff find files
|
||||
-- * <leader>fr show recent files
|
||||
-- * <leader>fb Foobar
|
||||
-- we'll document:
|
||||
-- * <leader>fn new file
|
||||
-- * <leader>fe edit file
|
||||
-- and hide <leader>1
|
||||
|
||||
wk.register({
|
||||
f = {
|
||||
name = "file", -- optional group name
|
||||
f = { "<cmd>Telescope find_files<cr>", "Find File" }, -- create a binding with label
|
||||
r = { "<cmd>Telescope oldfiles<cr>", "Open Recent File", noremap=false, buffer = 123 }, -- additional options for creating the keymap
|
||||
n = { "New File" }, -- just a label. don't create any mapping
|
||||
e = "Edit File", -- same as above
|
||||
["1"] = "which_key_ignore", -- special label to hide it in the popup
|
||||
b = { function() print("bar") end, "Foobar" } -- you can also pass functions!
|
||||
},
|
||||
}, { prefix = "<leader>" })
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>Click to see more examples</summary>
|
||||
|
||||
```lua
|
||||
-- all of the mappings below are equivalent
|
||||
|
||||
-- method 2
|
||||
wk.register({
|
||||
["<leader>"] = {
|
||||
f = {
|
||||
name = "+file",
|
||||
f = { "<cmd>Telescope find_files<cr>", "Find File" },
|
||||
r = { "<cmd>Telescope oldfiles<cr>", "Open Recent File" },
|
||||
n = { "<cmd>enew<cr>", "New File" },
|
||||
ellipsis = "…",
|
||||
-- set to false to disable all mapping icons,
|
||||
-- both those explicitely added in a mapping
|
||||
-- and those from rules
|
||||
mappings = true,
|
||||
--- See `lua/which-key/icons.lua` for more details
|
||||
--- Set to `false` to disable keymap icons from rules
|
||||
---@type wk.IconRule[]|false
|
||||
rules = {},
|
||||
-- use the highlights from mini.icons
|
||||
-- When `false`, it will use `WhichKeyIcon` instead
|
||||
colors = true,
|
||||
-- used by key format
|
||||
keys = {
|
||||
Up = " ",
|
||||
Down = " ",
|
||||
Left = " ",
|
||||
Right = " ",
|
||||
C = " ",
|
||||
M = " ",
|
||||
D = " ",
|
||||
S = " ",
|
||||
CR = " ",
|
||||
Esc = " ",
|
||||
ScrollWheelDown = " ",
|
||||
ScrollWheelUp = " ",
|
||||
NL = " ",
|
||||
BS = "",
|
||||
Space = " ",
|
||||
Tab = " ",
|
||||
F1 = "",
|
||||
F2 = "",
|
||||
F3 = "",
|
||||
F4 = "",
|
||||
F5 = "",
|
||||
F6 = "",
|
||||
F7 = "",
|
||||
F8 = "",
|
||||
F9 = "",
|
||||
F10 = "",
|
||||
F11 = "",
|
||||
F12 = "",
|
||||
},
|
||||
},
|
||||
})
|
||||
|
||||
-- method 3
|
||||
wk.register({
|
||||
["<leader>f"] = {
|
||||
name = "+file",
|
||||
f = { "<cmd>Telescope find_files<cr>", "Find File" },
|
||||
r = { "<cmd>Telescope oldfiles<cr>", "Open Recent File" },
|
||||
n = { "<cmd>enew<cr>", "New File" },
|
||||
show_help = true, -- show a help message in the command line for using WhichKey
|
||||
show_keys = true, -- show the currently pressed key and its label as a message in the command line
|
||||
-- disable WhichKey for certain buf types and file types.
|
||||
disable = {
|
||||
ft = {},
|
||||
bt = {},
|
||||
},
|
||||
})
|
||||
|
||||
-- method 4
|
||||
wk.register({
|
||||
["<leader>f"] = { name = "+file" },
|
||||
["<leader>ff"] = { "<cmd>Telescope find_files<cr>", "Find File" },
|
||||
["<leader>fr"] = { "<cmd>Telescope oldfiles<cr>", "Open Recent File" },
|
||||
["<leader>fn"] = { "<cmd>enew<cr>", "New File" },
|
||||
})
|
||||
debug = false, -- enable wk.log in the current directory
|
||||
}
|
||||
```
|
||||
|
||||
<!-- config:end -->
|
||||
|
||||
</details>
|
||||
|
||||
**Tips:** The default label is `keymap.desc` or `keymap.rhs` or `""`,
|
||||
`:h nvim_set_keymap()` to get more details about `desc` and `rhs`.
|
||||
## ⌨️ Mappings
|
||||
|
||||
### 🚙 Operators, Motions and Text Objects
|
||||
**WhichKey** automatically gets the descriptions of your keymaps from the `desc`
|
||||
attribute of the keymap. So for most use-cases, you don't need to do anything else.
|
||||
|
||||
**WhichKey** provides help to work with operators, motions and text objects.
|
||||
However, the **mapping spec** is still useful to configure group descriptions and mappings that don't really exist as a regular keymap.
|
||||
|
||||
> `[count]operator[count][text-object]`
|
||||
> [!WARNING]
|
||||
> The **mappings spec** changed in `v3`, so make sure to only use the new `add` method if
|
||||
> you updated your existing mappings.
|
||||
|
||||
- operators can be configured with the `operators` option
|
||||
- set `plugins.presets.operators` to `true` to automatically configure vim built-in operators
|
||||
- set this to `false`, to only include the list you configured in the `operators` option.
|
||||
- see [here](https://github.com/folke/which-key.nvim/blob/main/lua/which-key/plugins/presets/init.lua#L5) for the full list part of the preset
|
||||
- text objects are automatically retrieved from **operator pending** key maps (`omap`)
|
||||
- set `plugins.presets.text_objects` to `true` to configure built-in text objects
|
||||
- see [here](https://github.com/folke/which-key.nvim/blob/main/lua/which-key/plugins/presets/init.lua#L43)
|
||||
- motions are part of the preset `plugins.presets.motions` setting
|
||||
- see [here](https://github.com/folke/which-key.nvim/blob/main/lua/which-key/plugins/presets/init.lua#L20)
|
||||
Mappings can be added as part of the config `opts.spec`, or can be added later
|
||||
using `require("which-key").add()`.
|
||||
`wk.add()` can be called multiple times from anywhere in your config files.
|
||||
|
||||
<details>
|
||||
<summary>How to disable some operators? (like v)</summary>
|
||||
A mapping has the following attributes:
|
||||
|
||||
- **[1]**: (`string`) lhs **_(required)_**
|
||||
- **[2]**: (`string|fun()`) rhs **_(optional)_**: when present, it will create the mapping
|
||||
- **desc**: (`string|fun():string`) description **_(required for non-groups)_**
|
||||
- **group**: (`string|fun():string`) group name **_(optional)_**
|
||||
- **mode**: (`string|string[]`) mode **_(optional, defaults to `"n"`)_**
|
||||
- **cond**: (`boolean|fun():boolean`) condition to enable the mapping **_(optional)_**
|
||||
- **hidden**: (`boolean`) hide the mapping **_(optional)_**
|
||||
- **icon**: (`string|wk.Icon|fun():(wk.Icon|string)`) icon spec **_(optional)_**
|
||||
- **proxy**: (`string`) proxy to another mapping **_(optional)_**
|
||||
- **expand**: (`fun():wk.Spec`) nested mappings **_(optional)_**
|
||||
- any other option valid for `vim.keymap.set`. These are only used for creating mappings.
|
||||
|
||||
When `desc`, `group`, or `icon` are functions, they are evaluated every time
|
||||
the popup is shown.
|
||||
|
||||
The `expand` property allows to create dynamic mappings. Only functions as `rhs` are supported for dynamic mappings.
|
||||
Two examples are included in `which-key.extras`:
|
||||
|
||||
- `require("which-key.extras").expand.buf`: creates numerical key to buffer mappings
|
||||
- `require("which-key.extras").expand.win`: creates numerical key to window mappings
|
||||
|
||||
```lua
|
||||
-- make sure to run this code before calling setup()
|
||||
-- refer to the full lists at https://github.com/folke/which-key.nvim/blob/main/lua/which-key/plugins/presets/init.lua
|
||||
local presets = require("which-key.plugins.presets")
|
||||
presets.operators["v"] = nil
|
||||
local wk = require("which-key")
|
||||
wk.add({
|
||||
{ "<leader>f", group = "file" }, -- group
|
||||
{ "<leader>ff", "<cmd>Telescope find_files<cr>", desc = "Find File", mode = "n" },
|
||||
{ "<leader>fb", function() print("hello") end, desc = "Foobar" },
|
||||
{ "<leader>fn", desc = "New File" },
|
||||
{ "<leader>f1", hidden = true }, -- hide this keymap
|
||||
{ "<leader>w", proxy = "<c-w>", group = "windows" }, -- proxy to window mappings
|
||||
{ "<leader>b", group = "buffers", expand = function()
|
||||
return require("which-key.extras").expand.buf()
|
||||
end
|
||||
},
|
||||
{
|
||||
-- Nested mappings are allowed and can be added in any order
|
||||
-- Most attributes can be inherited or overridden on any level
|
||||
-- There's no limit to the depth of nesting
|
||||
mode = { "n", "v" }, -- NORMAL and VISUAL mode
|
||||
{ "<leader>q", "<cmd>q<cr>", desc = "Quit" }, -- no need to specify mode since it's inherited
|
||||
{ "<leader>w", "<cmd>w<cr>", desc = "Write" },
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
</details>
|
||||
## 🎯 Triggers
|
||||
|
||||
There's two ways that **which-key** can be triggered:
|
||||
|
||||
- by a trigger keymap
|
||||
- by a `ModeChanged` event for visual and operator pending mode
|
||||
|
||||
Both can be configured using `opts.triggers` and `opts.defer`.
|
||||
|
||||
By default `opts.triggers` includes `{ "<auto>", mode = "nixsotc" }`, which
|
||||
will setup keymap triggers for every mode automatically and will trigger during
|
||||
`ModeChanged`.
|
||||
|
||||
> [!NOTE]
|
||||
> Auto triggers will never be created for existing keymaps.
|
||||
> That includes every valid single key Neovim builtin mapping.
|
||||
> If you want to trigger on a builtin keymap, you have to add it manually.
|
||||
>
|
||||
> ```lua
|
||||
> triggers = {
|
||||
> { "<auto>", mode = "nixsotc" },
|
||||
> { "a", mode = { "n", "v" } },
|
||||
> }
|
||||
> ```
|
||||
|
||||
> [!TIP]
|
||||
> To manually setup triggers, you can set `opts.triggers` to:
|
||||
>
|
||||
> ```lua
|
||||
> triggers = {
|
||||
> { "<leader>", mode = { "n", "v" } },
|
||||
> }
|
||||
> ```
|
||||
|
||||
For `ModeChanged` triggers, you can configure the `opts.defer` option.
|
||||
When it returns `true`, the popup will be shown only after an additional key is pressed.
|
||||
So `yaf`, would show which-key after pressing `ya`, but not after `y`.
|
||||
|
||||
> [!TIP]
|
||||
> Defer some operators:
|
||||
>
|
||||
> ```lua
|
||||
> ---@param ctx { mode: string, operator: string }
|
||||
> defer = function(ctx)
|
||||
> if vim.list_contains({ "d", "y" }, ctx.operator) then
|
||||
> return true
|
||||
> end
|
||||
> return vim.list_contains({ "<C-V>", "V" }, ctx.mode)
|
||||
> end,
|
||||
> ```
|
||||
|
||||
## 🎨 Icons
|
||||
|
||||
> [!note]
|
||||
> For full support, you need to install either [mini.icons](https://github.com/echasnovski/mini.icons) or [nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons)
|
||||
|
||||
There's multiple ways to set icons for your keymaps:
|
||||
|
||||
- if you use lazy.nvim, then some icons will be autodetected for keymaps belonging to certain plugins.
|
||||
- custom rules to decide what icon to use
|
||||
- in your mapping spec, you can specify what icon to use at any level, so at the node for `<leader>g` for example, to apply to all git keymaps.
|
||||
|
||||
The `icon` attribute of a mapping can be a `string`, which will be used as the actual icon,
|
||||
or an `wk.Icon` object, which can have the following attributes:
|
||||
|
||||
- `icon` (`string`): the icon to use **_(optional)_**
|
||||
- `hl` (`string`): the highlight group to use for the icon **_(optional)_**
|
||||
- `color` (`string`): the color to use for the icon **_(optional)_**
|
||||
valid colors are: `azure`, `blue`, `cyan`, `green`, `grey`, `orange`, `purple`, `red`, `yellow`
|
||||
- `cat` (`string`): the category of the icon **_(optional)_**
|
||||
valid categories are: `file`, `filetype`, `extension`
|
||||
- `name` (`string`): the name of the icon in the specified category **_(optional)_**
|
||||
|
||||
> [!TIP]
|
||||
> If you'd rather not use icons, you can disable them
|
||||
> by setting `opts.icons.mappings` to `false`.
|
||||
|
||||
## 🚀 Usage
|
||||
|
||||
@ -308,60 +395,69 @@ When the **WhichKey** popup is open, you can use the following key bindings (the
|
||||
- `<c-d>` scroll down
|
||||
- `<c-u>` scroll up
|
||||
|
||||
Apart from the automatic opening, you can also manually open **WhichKey** for a certain `prefix`:
|
||||
## 🐙 Hydra Mode
|
||||
|
||||
> ❗️ don't create any keymappings yourself to trigger WhichKey. Unlike with _vim-which-key_, we do this fully automatically.
|
||||
> Please remove any left-over triggers you might have from using _vim-which-key_.
|
||||
Hydra mode is a special mode that keeps the popup open until you hit `<esc>`.
|
||||
|
||||
```vim
|
||||
:WhichKey " show all mappings
|
||||
:WhichKey <leader> " show all <leader> mappings
|
||||
:WhichKey <leader> v " show all <leader> mappings for VISUAL mode
|
||||
:WhichKey '' v " show ALL mappings for VISUAL mode
|
||||
```lua
|
||||
-- Show hydra mode for changing windows
|
||||
require("which-key").show({
|
||||
keys = "<c-w>",
|
||||
loop = true, -- this will keep the popup open until you hit <esc>
|
||||
})
|
||||
```
|
||||
|
||||
## 🔥 Plugins
|
||||
|
||||
Four built-in plugins are included with **WhichKey**.
|
||||
|
||||
### Presets
|
||||
|
||||
Built-in key binding help for `motions`, `text-objects`, `operators`, `windows`, `nav`, `z` and `g` and more.
|
||||
|
||||
### Marks
|
||||
|
||||
Shows a list of your buffer local and global marks when you hit \` or '
|
||||
|
||||
|
||||
|
||||
|
||||
### Registers
|
||||
|
||||
Shows a list of your buffer local and global registers when you hit " in _NORMAL_ mode, or `<c-r>` in _INSERT_ mode.
|
||||
|
||||
|
||||
|
||||
### Presets
|
||||
|
||||
Built-in key binding help for `motions`, `text-objects`, `operators`, `windows`, `nav`, `z` and `g`
|
||||
|
||||
|
||||
|
||||
|
||||
### Spelling
|
||||
|
||||
When enabled, this plugin hooks into `z=` and replaces the full-screen spelling suggestions window by a list of suggestions within **WhichKey**.
|
||||
|
||||
|
||||
|
||||
|
||||
## 🎨 Colors
|
||||
|
||||
The table below shows all the highlight groups defined for **WhichKey** with their default link.
|
||||
|
||||
| Highlight Group | Defaults to | Description |
|
||||
| ------------------- | ----------- | ------------------------------------------- |
|
||||
| _WhichKey_ | Function | the key |
|
||||
| _WhichKeyGroup_ | Keyword | a group |
|
||||
| _WhichKeySeparator_ | DiffAdd | the separator between the key and its label |
|
||||
| _WhichKeyDesc_ | Identifier | the label of the key |
|
||||
| _WhichKeyFloat_ | NormalFloat | Normal in the popup window |
|
||||
| _WhichKeyBorder_ | FloatBorder | Normal in the popup window |
|
||||
| _WhichKeyValue_ | Comment | used by plugins that provide values |
|
||||
<!-- colors:start -->
|
||||
|
||||
<!-- markdownlint-disable-file MD033 -->
|
||||
<!-- markdownlint-configure-file { "MD013": { "line_length": 120 } } -->
|
||||
<!-- markdownlint-configure-file { "MD004": { "style": "sublist" } } -->
|
||||
| Highlight Group | Default Group | Description |
|
||||
| --- | --- | --- |
|
||||
| **WhichKey** | ***Function*** | |
|
||||
| **WhichKeyBorder** | ***FloatBorder*** | Border of the which-key window |
|
||||
| **WhichKeyDesc** | ***Identifier*** | description |
|
||||
| **WhichKeyGroup** | ***Keyword*** | group name |
|
||||
| **WhichKeyIcon** | ***@markup.link*** | icons |
|
||||
| **WhichKeyIconAzure** | ***Function*** | |
|
||||
| **WhichKeyIconBlue** | ***DiagnosticInfo*** | |
|
||||
| **WhichKeyIconCyan** | ***DiagnosticHint*** | |
|
||||
| **WhichKeyIconGreen** | ***DiagnosticOk*** | |
|
||||
| **WhichKeyIconGrey** | ***Normal*** | |
|
||||
| **WhichKeyIconOrange** | ***DiagnosticWarn*** | |
|
||||
| **WhichKeyIconPurple** | ***Constant*** | |
|
||||
| **WhichKeyIconRed** | ***DiagnosticError*** | |
|
||||
| **WhichKeyIconYellow** | ***DiagnosticWarn*** | |
|
||||
| **WhichKeyNormal** | ***NormalFloat*** | Normal in th which-key window |
|
||||
| **WhichKeySeparator** | ***Comment*** | the separator between the key and its description |
|
||||
| **WhichKeyTitle** | ***FloatTitle*** | Title of the which-key window |
|
||||
| **WhichKeyValue** | ***Comment*** | values by plugins (like marks, registers, etc) |
|
||||
|
||||
<!-- colors:end -->
|
||||
|
||||
Reference in New Issue
Block a user