mirror of
https://github.com/folke/snacks.nvim
synced 2025-07-07 21:25:11 +00:00
4c3bfa29f3
## Description
From the docs on `:help vim.ui.select`
```
• {on_choice} (`fun(item: any?, idx: integer?)`) Called once the user
made a choice. `idx` is the 1-based index of `item`
within `items`. `nil` if the user aborted the dialog.
```
Right now the behavior will call `on_choice` if the user confirmed a
selection, but will not be called at all if the user explicitly or
implicitly closes the picker. As a plugin author, I rely on the
guarantee that if I call `vim.ui.select`, the callback _will_ be called
either with a value or with a nil.
I just added the simplest, dumbest possible fix for this that prevents
double-calling the callback.
## Related Issue(s)
N/A
## Screenshots
N/A
63 lines
1.7 KiB
Lua
63 lines
1.7 KiB
Lua
local M = {}
|
|
|
|
---@alias snacks.picker.ui_select fun(items: any[], opts?: {prompt?: string, format_item?: (fun(item: any): string), kind?: string}, on_choice: fun(item?: any, idx?: number))
|
|
|
|
---@generic T
|
|
---@param items T[] Arbitrary items
|
|
---@param opts? {prompt?: string, format_item?: (fun(item: T): string), kind?: string}
|
|
---@param on_choice fun(item?: T, idx?: number)
|
|
function M.select(items, opts, on_choice)
|
|
assert(type(on_choice) == "function", "on_choice must be a function")
|
|
opts = opts or {}
|
|
|
|
---@type snacks.picker.finder.Item[]
|
|
local finder_items = {}
|
|
for idx, item in ipairs(items) do
|
|
local text = (opts.format_item or tostring)(item)
|
|
table.insert(finder_items, {
|
|
formatted = text,
|
|
text = idx .. " " .. text,
|
|
item = item,
|
|
idx = idx,
|
|
})
|
|
end
|
|
|
|
local title = opts.prompt or "Select"
|
|
title = title:gsub("^%s*", ""):gsub("[%s:]*$", "")
|
|
local completed = false
|
|
|
|
---@type snacks.picker.finder.Item[]
|
|
return Snacks.picker.pick({
|
|
source = "select",
|
|
items = finder_items,
|
|
format = Snacks.picker.format.ui_select(opts.kind, #items),
|
|
title = title,
|
|
layout = {
|
|
preview = false,
|
|
layout = {
|
|
height = math.floor(math.min(vim.o.lines * 0.8 - 10, #items + 2) + 0.5),
|
|
},
|
|
},
|
|
actions = {
|
|
confirm = function(picker, item)
|
|
if completed then
|
|
return
|
|
end
|
|
completed = true
|
|
picker:close()
|
|
vim.schedule(function()
|
|
on_choice(item and item.item, item and item.idx)
|
|
end)
|
|
end,
|
|
},
|
|
on_close = function()
|
|
if completed then
|
|
return
|
|
end
|
|
completed = true
|
|
vim.schedule(on_choice)
|
|
end,
|
|
})
|
|
end
|
|
|
|
return M
|