diff options
| author | zeertzjq <zeertzjq@outlook.com> | 2022-03-02 15:05:19 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-02 15:05:19 +0800 |
| commit | 4b3f920477e9838c3f3a9cd67a47d1494b9cc229 (patch) | |
| tree | 7b121422d00fbe56ad43578cb2f612a54d7cf36c | |
| parent | 4c24fcb91f7740410b94638b3156ba20647df579 (diff) | |
| parent | f6df44232c6780eb780143ef05e8f8e6951a17cb (diff) | |
| download | rneovim-4b3f920477e9838c3f3a9cd67a47d1494b9cc229.tar.gz rneovim-4b3f920477e9838c3f3a9cd67a47d1494b9cc229.tar.bz2 rneovim-4b3f920477e9838c3f3a9cd67a47d1494b9cc229.zip | |
Merge pull request #16804 from zeertzjq/ui-aucmd-docs
docs: clarify UIEnter and UILeave docs
| -rw-r--r-- | runtime/doc/autocmd.txt | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/runtime/doc/autocmd.txt b/runtime/doc/autocmd.txt index 9054bedc8d..4b8c07fde4 100644 --- a/runtime/doc/autocmd.txt +++ b/runtime/doc/autocmd.txt @@ -674,15 +674,19 @@ FuncUndefined When a user function is used but it isn't alternative is to use an autoloaded function. See |autoload-functions|. *UIEnter* -UIEnter After a UI connects via |nvim_ui_attach()|, - after VimEnter. Can be used for GUI-specific - configuration. +UIEnter After a UI connects via |nvim_ui_attach()|, or + after builtin TUI is started, after |VimEnter|. Sets these |v:event| keys: - chan + chan: 0 for builtin TUI + 1 for |--embed| + |channel-id| of the UI otherwise *UILeave* -UILeave After a UI disconnects from Nvim. +UILeave After a UI disconnects from Nvim, or after + builtin TUI is stopped, after |VimLeave|. Sets these |v:event| keys: - chan + chan: 0 for builtin TUI + 1 for |--embed| + |channel-id| of the UI otherwise *InsertChange* InsertChange When typing <Insert> while in Insert or Replace mode. The |v:insertmode| variable |