Merge pull request #16804 from zeertzjq/ui-aucmd-docs

docs: clarify UIEnter and UILeave docs
This commit is contained in:
zeertzjq 2022-03-02 15:05:19 +08:00 committed by GitHub
commit 4b3f920477
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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