aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/ui.txt
diff options
context:
space:
mode:
authorDongdong Zhou <dzhou121@gmail.com>2017-02-24 06:12:34 +0000
committerBjörn Linse <bjorn.linse@gmail.com>2017-10-29 08:18:03 +0100
commit39e83fa7cb4486d30f788c3b27594d106d5e76ab (patch)
treecbfb2af155e501477a1edc4c45d47cad3f4fe785 /runtime/doc/ui.txt
parent2a3bcd1ff883429a3dd17e7ae5ddc1396abbad17 (diff)
downloadrneovim-39e83fa7cb4486d30f788c3b27594d106d5e76ab.tar.gz
rneovim-39e83fa7cb4486d30f788c3b27594d106d5e76ab.tar.bz2
rneovim-39e83fa7cb4486d30f788c3b27594d106d5e76ab.zip
ui: allow external ui to draw wildmenu
Co-authored-by: Björn Linse <bjorn.linse@gmail.com> Updated docs and tests.
Diffstat (limited to 'runtime/doc/ui.txt')
-rw-r--r--runtime/doc/ui.txt19
1 files changed, 19 insertions, 0 deletions
diff --git a/runtime/doc/ui.txt b/runtime/doc/ui.txt
index deac1609c0..5306126e7f 100644
--- a/runtime/doc/ui.txt
+++ b/runtime/doc/ui.txt
@@ -28,6 +28,7 @@ a dictionary with these (optional) keys:
`ext_popupmenu` Externalize the popupmenu. |ui-popupmenu|
`ext_tabline` Externalize the tabline. |ui-tabline|
`ext_cmdline` Externalize the cmdline. |ui-cmdline|
+ `ext_wildmenu` Externalize the tabline. |ui-ext-wildmenu|
Nvim will then send msgpack-rpc notifications, with the method name "redraw"
and a single argument, an array of screen update events.
@@ -287,4 +288,22 @@ Only sent if `ext_cmdline` option is set in |ui-options|
Hide the block.
==============================================================================
+Wildmenu Events *ui-wildmenu*
+
+Only sent if `ext_wildmenu` option is set in |ui-options|
+
+["wildmenu_show", items]
+ When `ext_wildmenu` is set to true, nvim will not draw the
+ wildmenu on the grid, instead when the wildmenu is to be displayed
+ this update is sent. `items` is an array of the completion items.
+
+["wildmenu_select", selected]
+ An item in the currently displayed wildmenu is selected. `selected`
+ is either a zero-based index into the array of items from the last
+ wildmenu event, or -1 if no item is selected.
+
+["wildmenu_hide"]
+ The wildmenu is hidden.
+
+==============================================================================
vim:tw=78:ts=8:noet:ft=help:norl: