mirrors/snacks.nvim
1
0
Fork 0
mirror of https://github.com/folke/snacks.nvim synced 2025-12-23 08:47:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

chore(build): auto-generate docs
Some checks are pending
CI / ci (push) Waiting to run
Details

Browse source
This commit is contained in:
folke 2025-10-11 09:10:44 +00:00 • committed by github-actions[bot]
parent 5c63614880
commit aaab014bc6
2 changed files with 24 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/snacks.nvim.txt
View file

@ -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*

45
docs/picker.md
View file

@ -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()
```