diff options
| author | bfredl <bjorn.linse@gmail.com> | 2023-12-16 12:41:05 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-12-16 12:41:05 +0100 |
| commit | 5ed55ff14c8b7e346811cb6228bf63fb5106bae9 (patch) | |
| tree | d27158d56da5810b942a3d561ae15b2711b2a7cd /runtime/doc | |
| parent | 7e7da962de404e3a0952bcc0adc6fbe53eda3cfb (diff) | |
| parent | e38027ef69f75653ee953b16ebf4a8652a3fb748 (diff) | |
| download | rneovim-5ed55ff14c8b7e346811cb6228bf63fb5106bae9.tar.gz rneovim-5ed55ff14c8b7e346811cb6228bf63fb5106bae9.tar.bz2 rneovim-5ed55ff14c8b7e346811cb6228bf63fb5106bae9.zip | |
Merge pull request #24723 from glepnir/popup
feat(complete): completeopt support popup like vim
Diffstat (limited to 'runtime/doc')
| -rw-r--r-- | runtime/doc/api.txt | 15 | ||||
| -rw-r--r-- | runtime/doc/builtin.txt | 2 | ||||
| -rw-r--r-- | runtime/doc/news.txt | 3 | ||||
| -rw-r--r-- | runtime/doc/options.txt | 4 |
4 files changed, 24 insertions, 0 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 48bbdc33df..72ac357ac0 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -700,6 +700,21 @@ nvim_chan_send({chan}, {data}) *nvim_chan_send()* • {chan} id of the channel • {data} data to write. 8-bit clean: can contain NUL bytes. +nvim_complete_set({index}, {*opts}) *nvim_complete_set()* + Set info for the completion candidate index. if the info was shown in a + window, then the window and buffer ids are returned for further + customization. If the text was not shown, an empty dict is returned. + + Parameters: ~ + • {index} the completion candidate index + • {opts} Optional parameters. + • info: (string) info text. + + Return: ~ + Dictionary containing these keys: + • winid: (number) floating window id + • bufnr: (number) buffer id in floating window + nvim_create_buf({listed}, {scratch}) *nvim_create_buf()* Creates a new, empty, unnamed buffer. diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt index 714320279a..98201c0eed 100644 --- a/runtime/doc/builtin.txt +++ b/runtime/doc/builtin.txt @@ -802,6 +802,8 @@ complete_info([{what}]) *complete_info()* no item is selected when using the <Up> or <Down> keys) inserted Inserted string. [NOT IMPLEMENTED YET] + preview_winid Info floating preview window id. + preview_bufnr Info floating preview buffer id. *complete_info_mode* mode values are: diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt index ad2de7a40a..406ac879eb 100644 --- a/runtime/doc/news.txt +++ b/runtime/doc/news.txt @@ -252,6 +252,9 @@ The following new APIs and features were added. • |vim.text.hexencode()| and |vim.text.hexdecode()| convert strings to and from byte representations. +• 'completeopt' option supports "popup" flags to show extra information in + in floating window. + ============================================================================== CHANGED FEATURES *news-changed* diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index fda60eaab2..970f687c99 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -1516,6 +1516,10 @@ A jump table for the options with a short description can be found at |Q_op|. select one from the menu. Only works in combination with "menu" or "menuone". + popup Show extra information about the currently selected + completion in a popup window. Only works in combination + with "menu" or "menuone". Overrides "preview". + *'completeslash'* *'csl'* 'completeslash' 'csl' string (default "") local to buffer |