mirror of
https://github.com/neovim/neovim.git
synced 2025-11-04 01:34:25 +00:00
16d4af6d2f
* vim.ui.input is an overridable function that prompts for user input * take an opts table and the `on_confirm` callback, see `:help vim.ui.input` for more details * defaults to a wrapper around vim.fn.input(opts) * switches the built-in client's rename handler to use vim.ui.input by default
75 lines
2.6 KiB
Lua
75 lines
2.6 KiB
Lua
local M = {}
|
|
|
|
--- Prompts the user to pick a single item from a collection of entries
|
|
---
|
|
---@param items table Arbitrary items
|
|
---@param opts table Additional options
|
|
--- - prompt (string|nil)
|
|
--- Text of the prompt. Defaults to `Select one of:`
|
|
--- - 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`.
|
|
--- `nil` if the user aborted the dialog.
|
|
function M.select(items, opts, on_choice)
|
|
vim.validate {
|
|
items = { items, 'table', false },
|
|
on_choice = { on_choice, 'function', false },
|
|
}
|
|
opts = opts or {}
|
|
local choices = {opts.prompt or 'Select one of:'}
|
|
local format_item = opts.format_item or tostring
|
|
for i, item in pairs(items) do
|
|
table.insert(choices, string.format('%d: %s', i, format_item(item)))
|
|
end
|
|
local choice = vim.fn.inputlist(choices)
|
|
if choice < 1 or choice > #items then
|
|
on_choice(nil, nil)
|
|
else
|
|
on_choice(items[choice], choice)
|
|
end
|
|
end
|
|
|
|
--- Prompts the user for input
|
|
---
|
|
---@param opts table Additional options. See |input()|
|
|
--- - prompt (string|nil)
|
|
--- Text of the prompt. Defaults to `Input: `.
|
|
--- - default (string|nil)
|
|
--- Default reply to the input
|
|
--- - completion (string|nil)
|
|
--- Specifies type of completion supported
|
|
--- for input. Supported types are the same
|
|
--- that can be supplied to a user-defined
|
|
--- command using the "-complete=" argument.
|
|
--- See |:command-completion|
|
|
--- - highlight (function)
|
|
--- Function that will be used for highlighting
|
|
--- user inputs.
|
|
---@param on_confirm function ((input|nil) -> ())
|
|
--- Called once the user confirms or abort the input.
|
|
--- `input` is what the user typed.
|
|
--- `nil` if the user aborted the dialog.
|
|
function M.input(opts, on_confirm)
|
|
vim.validate {
|
|
on_confirm = { on_confirm, 'function', false },
|
|
}
|
|
|
|
opts = opts or {}
|
|
local input = vim.fn.input(opts)
|
|
if #input > 0 then
|
|
on_confirm(input)
|
|
else
|
|
on_confirm(nil)
|
|
end
|
|
end
|
|
|
|
return M
|