diff options
| author | zeertzjq <zeertzjq@outlook.com> | 2024-03-31 11:20:05 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-03-31 11:20:05 +0800 |
| commit | e1ff2c51cad755d0ddc04a23df23e317d77023ed (patch) | |
| tree | a32389bcb708f2b0efed0134ffafc206b527db08 /runtime/doc | |
| parent | 12240600f5d2c992aa77bc4592edc16814abfafd (diff) | |
| download | rneovim-e1ff2c51cad755d0ddc04a23df23e317d77023ed.tar.gz rneovim-e1ff2c51cad755d0ddc04a23df23e317d77023ed.tar.bz2 rneovim-e1ff2c51cad755d0ddc04a23df23e317d77023ed.zip | |
feat(lua): pass keys before mapping to vim.on_key() callback (#28098)
Keys before mapping (i.e. typed keys) are passed as the second argument.
Diffstat (limited to 'runtime/doc')
| -rw-r--r-- | runtime/doc/lua.txt | 10 | ||||
| -rw-r--r-- | runtime/doc/news.txt | 3 |
2 files changed, 9 insertions, 4 deletions
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index e02ed20644..d967e2b313 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -1640,12 +1640,14 @@ vim.on_key({fn}, {ns_id}) *vim.on_key()* Note: ~ • {fn} will be removed on error. • {fn} will not be cleared by |nvim_buf_clear_namespace()| - • {fn} will receive the keys after mappings have been evaluated Parameters: ~ - • {fn} (`fun(key: string)?`) Function invoked on every key press. - |i_CTRL-V| Passing in nil when {ns_id} is specified removes - the callback associated with namespace {ns_id}. + • {fn} (`fun(key: string, typed: string)?`) Function invoked on + every key press. |i_CTRL-V| {key} is the key after mappings + have been applied, and {typed} is the key(s) before mappings + are applied, which may be empty if {key} is produced by + non-typed keys. When {fn} is nil and {ns_id} is specified, + the callback associated with namespace {ns_id} is removed. • {ns_id} (`integer?`) Namespace ID. If nil or 0, generates and returns a new |nvim_create_namespace()| id. diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt index 1aee5c656b..e39cf95da9 100644 --- a/runtime/doc/news.txt +++ b/runtime/doc/news.txt @@ -354,6 +354,9 @@ The following changes to existing APIs or features add new behavior. • |vim.region()| can use a string accepted by |getpos()| as position. +• |vim.on_key()| callbacks receive a second argument for keys typed before + mappings are applied. + • |vim.diagnostic.config()| now accepts a function for the virtual_text.prefix option, which allows for rendering e.g., diagnostic severities differently. |