feat(ui-select): support optional preview of items (#124)

Bekaboo · Feb 7, 2024 · f835519 · f835519
1 parent c3de6fe
commit f835519
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -2062,8 +2062,10 @@ Declared in [`lua/dropbar/utils/menu.lua`](https://github.com/Bekaboo/dropbar.nv
 
 | Field         | Type                                                                          | Description                                                                                                                                          |
 | ------        | ------                                                                        | ------                                                                                                                                               |
-| `prompt`      | `string?`                                                                     | determines what will be shown at the top of the select menu.                                                                                         |
-| `format_item` | `fun(item: any): string, string[][]?`                                         | formats the list items for display in the menu, and optionally formats virtual text chunks to be shown below the item.                               |
+| `prompt`        | `string?`                                                                       | determines what will be shown at the top of the select menu.                                                                                         |
+| `format_item`   | `fun(item: any): string, string[][]?`                                           | formats the list items for display in the menu, and optionally formats virtual text chunks to be shown below the item.                               |
+| `preview`       | `fun(self: dropbar_symbol_t, item: any, idx: integer)`                          | previews the list item under the cursor.                                                                                                             |
+| `preview_close` | `fun(self: dropbar_symbol_t, item: any, idx: integer)`                          | closes the preview when the menu is closed.                                                                                                          |
 
 ### Making a New Source
 

diff --git a/lua/dropbar/utils/menu.lua b/lua/dropbar/utils/menu.lua
@@ -97,6 +97,8 @@ end
 ---The second return value is a list of virtual text chunks to be displayed below the item. If
 ---nothing is returned for the second value, no virtual text will be displayed.
 ---@field format_item? fun(item: any): string, string[][]?
+---@field preview? fun(self: dropbar_symbol_t, item: any, idx: integer)
+---@field preview_close? fun(self: dropbar_symbol_t, item: any, idx: integer)
 
 ---@param items string[]|table[] list of items to be selected
 ---@param opts dropbar_select_opts_t
@@ -149,6 +151,16 @@ function M.select(items, opts, on_choice)
             ),
             icon_hl = 'DropBarIconUIIndicator',
             name = text,
+            preview = function(self)
+              if opts.preview then
+                opts.preview(self, item, idx)
+              end
+            end,
+            preview_restore_view = function(self)
+              if opts.preview_close then
+                opts.preview_close(self, item, idx)
+              end
+            end,
             on_click = function(self)
               self.entry.menu:close()
               if on_choice then