Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

nx.keymap

nx.keymap.set(mode, lhs, rhs, opts)

nx.keymap.set(mode, lhs, rhs, opts): map lhs to rhs in mode. rhs is a function (stored in nx._keymap_fns) or a string (fed as keys). Maps are non-recursive by default (the nx.keymap.set convention); pass opts.remap = true for a recursive map whose RHS keys are re-fed through the mapping layer (or, equivalently, opts.noremap = false). opts.desc is stored but unused; opts.buffer ties the map to one buffer (0 = current), opts.default marks an overridable built-in — both feed the precedence ladder the server applies.

Defined in keymap.lua.

nx.keymap.del(mode, lhs, opts)

nx.keymap.del(mode, lhs, opts): remove the mapping(s) for lhs in mode. opts.buffer (0 = current) targets a buffer-local map; absent targets globals.

Defined in keymap.lua.

nx.keymap.raw_buf_set(buffer, mode, lhs, rhs, opts)

nx.keymap.raw_buf_set(buffer, mode, lhs, rhs, opts) [alias nvim_buf_set_keymap].

Defined in keymap.lua.

nx.keymap.raw_set(mode, lhs, rhs, opts)

nx.keymap.raw_set(mode, lhs, rhs, opts) [alias nvim_set_keymap]: the global form of the raw setter (a buffer-less raw_buf_set).

Defined in keymap.lua.

nx.keymap.buf_del(buffer, mode, lhs)

nx.keymap.buf_del(buffer, mode, lhs) [alias nvim_buf_del_keymap]: remove a buffer-local mapping. The global form, nvim_del_keymap, aliases nx.keymap.del directly — its (mode, lhs) call already matches nx.keymap.del’s signature.

Defined in keymap.lua.

nx.keymap.get(mode)

nx.keymap.get(mode) [alias nvim_get_keymap]: every GLOBAL mapping that applies in mode, as maparg dicts. Buffer-local maps are excluded (nx.keymap.buf_get returns those).

Defined in keymap.lua.

nx.keymap.buf_get(buffer, mode)

nx.keymap.buf_get(buffer, mode) [alias nvim_buf_get_keymap]: the BUFFER-LOCAL mappings of buffer (0 = current) that apply in mode, as maparg dicts.

Defined in keymap.lua.

nx.keymap.arg(name, mode, _abbr, dict)

nx.keymap.arg(name, mode, abbr, dict) [alias vim.fn.maparg]: the mapping bound to name in mode. With dict truthy returns the full maparg dict (or {} when unmapped); else the rhs string (“” when unmapped, or for a function RHS). abbr (abbreviation lookup) is accepted and ignored — nxvim has no abbreviations. A buffer-local map for the current buffer shadows a global one at the same lhs.

Defined in keymap.lua.