diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2026-05-30 07:35:05 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-05-30 07:35:05 -0400 |
| commit | a9ef07681796f68324c59cd110f429247e142d1b (patch) | |
| tree | 5ac952bcfef2f6d39cae1b2953ed8dc83164e04c /runtime/lua/vim/keymap.lua | |
| parent | 6b799ee40a5729b6b2c7264b3987d1abf16839b6 (diff) | |
| parent | f5fae7aa5cf1e599b2bbc0ef0ae6deccc8c0b3d5 (diff) | |
| download | rneovim-a9ef07681796f68324c59cd110f429247e142d1b.tar.gz rneovim-a9ef07681796f68324c59cd110f429247e142d1b.tar.bz2 rneovim-a9ef07681796f68324c59cd110f429247e142d1b.zip | |
Merge #39908 from justinmk/doc2
docs: misc
Diffstat (limited to 'runtime/lua/vim/keymap.lua')
| -rw-r--r-- | runtime/lua/vim/keymap.lua | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/runtime/lua/vim/keymap.lua b/runtime/lua/vim/keymap.lua index ade3c752d6..4b9a32ff8c 100644 --- a/runtime/lua/vim/keymap.lua +++ b/runtime/lua/vim/keymap.lua @@ -16,7 +16,8 @@ local keymap = {} --- (Default: `false`) --- @field remap? boolean ---- Defines a |mapping| of |keycodes| to a function or keycodes. +--- Defines a |mapping| of |keycodes| to a function or keycodes. If `lhs` is a list, defines +--- a mapping for each (mode, lhs) pair. --- --- Examples: --- @@ -43,6 +44,13 @@ local keymap = {} --- local line2 = region[#region][1][2] --- vim.print({ line1, line2 }) --- end) +--- +--- vim.keymap.set({ 'n', 'i' }, { 'a', 'b' }, '<cmd>echom localtime()<cr>') +--- -- ... is the same as: +--- vim.keymap.set('n', 'a', '<cmd>echom localtime()<cr>') +--- vim.keymap.set('i', 'a', '<cmd>echom localtime()<cr>') +--- vim.keymap.set('n', 'b', '<cmd>echom localtime()<cr>') +--- vim.keymap.set('i', 'b', '<cmd>echom localtime()<cr>') --- ``` --- ---@param modes string|string[] Mode "short-name" (see |nvim_set_keymap()|), or a list thereof. @@ -112,12 +120,11 @@ end --- Remove a mapping from the given buffer. `0` for current. --- @field buf? integer ---- Remove an existing mapping. +--- Removes a mapping, or removes each (mode, lhs) pair if `lhs` is a list. --- Examples: --- --- ```lua --- vim.keymap.del('n', 'lhs') ---- --- vim.keymap.del({'n', 'i', 'v'}, '<leader>w', { buf = 5 }) --- ``` --- |