From aaab014bc6094514cfd3fae1d3bae92b8f91d519 Mon Sep 17 00:00:00 2001 From: folke <292349+folke@users.noreply.github.com> Date: Sat, 11 Oct 2025 09:10:44 +0000 Subject: [PATCH] chore(build): auto-generate docs --- doc/snacks.nvim.txt | 2 +- docs/picker.md | 45 +++++++++++++++++++++++---------------------- 2 files changed, 24 insertions(+), 23 deletions(-) diff --git a/doc/snacks.nvim.txt b/doc/snacks.nvim.txt index a15346eb..83088e18 100644 --- a/doc/snacks.nvim.txt +++ b/doc/snacks.nvim.txt @@ -1,4 +1,4 @@ -*snacks.nvim.txt* For Neovim Last change: 2025 October 10 +*snacks.nvim.txt* For Neovim Last change: 2025 October 11 ============================================================================== Table of Contents *snacks.nvim-table-of-contents* diff --git a/docs/picker.md b/docs/picker.md index da9fb703..85ad6671 100644 --- a/docs/picker.md +++ b/docs/picker.md @@ -619,23 +619,6 @@ Snacks.picker.pick({source = "files", ...}) ---@field expr string ``` -```lua ----@alias snacks.Picker.ref (fun():snacks.Picker?)|{value?: snacks.Picker} -``` - -```lua ----@class snacks.picker.Last ----@field cursor number ----@field topline number ----@field opts? snacks.picker.Config ----@field selected snacks.picker.Item[] ----@field filter snacks.picker.Filter -``` - -```lua ----@alias snacks.picker.history.Record {pattern: string, search: string, live?: boolean} -``` - ```lua ---@alias snacks.picker.Extmark vim.api.keyset.set_extmark|{col:number, row?:number, field?:string} ---@alias snacks.picker.Text {[1]:string, [2]:string?, virtual?:boolean, field?:string} @@ -705,6 +688,7 @@ It's a previewer that shows a preview based on the item data. ---@field preset? string|fun(source:string):string ---@field hidden? ("input"|"preview"|"list")[] don't show the given windows when opening the picker. (only "input" and "preview" make sense) ---@field auto_hide? ("input"|"preview"|"list")[] hide the given windows when not focused (only "input" makes real sense) +---@field config? fun(layout:snacks.picker.layout.Config) customize the resolved layout config ``` ```lua @@ -714,6 +698,23 @@ It's a previewer that shows a preview based on the item data. ---@field preview? snacks.win.Config|{} preview window config ``` +```lua +---@alias snacks.Picker.ref (fun():snacks.Picker?)|{value?: snacks.Picker} +``` + +```lua +---@class snacks.picker.Last +---@field cursor number +---@field topline number +---@field opts? snacks.picker.Config +---@field selected snacks.picker.Item[] +---@field filter snacks.picker.Filter +``` + +```lua +---@alias snacks.picker.history.Record {pattern: string, search: string, live?: boolean} +``` + ## 📦 Module ```lua @@ -2239,7 +2240,7 @@ M.sidebar ```lua { - preview = false, + hidden = { "preview" }, layout = { backdrop = false, width = 0.5, @@ -2341,13 +2342,13 @@ M.sidebar ```lua { - preview = false, + hidden = { "preview" }, layout = { backdrop = false, row = 1, width = 0.4, min_width = 80, - height = 0.7, + height = 0.4, border = "none", box = "vertical", { win = "input", height = 1, border = "rounded", title = "{title} {live} {flags}", title_pos = "center" }, @@ -2731,6 +2732,8 @@ Snacks.picker.actions.toggle_preview(picker) Snacks.picker.actions.yank(picker, item, action) ``` + + ## 📦 `snacks.picker.core.picker` ```lua @@ -2985,5 +2988,3 @@ Get the word under the cursor or the current visual selection ```lua picker:word() ``` - -