diff options
| author | Zachary Churchill <zacharyachurchill@gmail.com> | 2021-10-31 20:15:09 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-31 17:15:09 -0700 |
| commit | 7ae86c1d4caffec57e2d4d44e40a9feba91d96dd (patch) | |
| tree | e5dc7de9c02a7cc733e68ec74e6f54584f82da71 /runtime/lua/vim/ui.lua | |
| parent | a68faed02dc8e37b8f10da14dc02e33e6ed93947 (diff) | |
| download | rneovim-7ae86c1d4caffec57e2d4d44e40a9feba91d96dd.tar.gz rneovim-7ae86c1d4caffec57e2d4d44e40a9feba91d96dd.tar.bz2 rneovim-7ae86c1d4caffec57e2d4d44e40a9feba91d96dd.zip | |
feat(ui): add `opt.kind` to `vim.ui.select` (#15838)
Co-authored-by: Justin M. Keyes <justinkz@gmail.com>
Diffstat (limited to 'runtime/lua/vim/ui.lua')
| -rw-r--r-- | runtime/lua/vim/ui.lua | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/runtime/lua/vim/ui.lua b/runtime/lua/vim/ui.lua index 5eab20fc54..adc1e16759 100644 --- a/runtime/lua/vim/ui.lua +++ b/runtime/lua/vim/ui.lua @@ -9,6 +9,11 @@ local M = {} --- - format_item (function item -> text) --- Function to format an --- individual item from `items`. Defaults to `tostring`. +--- - kind (string|nil) +--- Arbitrary hint string indicating the item shape. +--- Plugins reimplementing `vim.ui.select` may wish to +--- use this to infer the structure or semantics of +--- `items`, or the context in which select() was called. ---@param on_choice function ((item|nil, idx|nil) -> ()) --- Called once the user made a choice. --- `idx` is the 1-based index of `item` within `item`. |