mirrors/snacks.nvim
1
0
Fork 0
mirror of https://github.com/folke/snacks.nvim synced 2025-07-07 21:25:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

chore(build): auto-generate docs

Browse source
This commit is contained in:
folke 2025-02-07 05:39:32 +00:00 • committed by github-actions[bot]
parent b1db65ac61
commit 698daf7cdf
3 changed files with 25 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

38
docs/picker.md
View file

@ -578,6 +578,23 @@ Snacks.picker.pick({source = "files", ...})
---@field layout? snacks.picker.layout.Config|string ---@field layout? snacks.picker.layout.Config|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 ```lua
---@alias snacks.picker.Extmark vim.api.keyset.set_extmark|{col:number, row?:number, field?:string} ---@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} ---@alias snacks.picker.Text {[1]:string, [2]:string?, virtual?:boolean, field?:string}
@ -654,23 +671,6 @@ It's a previewer that shows a preview based on the item data.
---@field preview? snacks.win.Config|{} preview window config ---@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 ## 📦 Module
```lua ```lua
@ -2538,8 +2538,6 @@ Snacks.picker.actions.toggle_preview(picker)
Snacks.picker.actions.yank(_, item) Snacks.picker.actions.yank(_, item)
``` ```
## 📦 `snacks.picker.core.picker` ## 📦 `snacks.picker.core.picker`
```lua ```lua
@ -2773,3 +2771,5 @@ Get the word under the cursor or the current visual selection
```lua ```lua
picker:word() picker:word()
``` ```

3
docs/styles.md
View file

@ -296,6 +296,9 @@ The other options are used with `:lua Snacks.dashboard()`
wo = { wo = {
winhighlight = "NormalFloat:Normal", winhighlight = "NormalFloat:Normal",
}, },
w = {
snacks_main = true,
},
} }
``` ```

3
docs/zen.md
View file

@ -91,6 +91,9 @@ docs for more information on how to customize these styles
wo = { wo = {
winhighlight = "NormalFloat:Normal", winhighlight = "NormalFloat:Normal",
}, },
w = {
snacks_main = true,
},
} }
``` ```