mirrors/snacks.nvim
1
0
Fork 0
mirror of https://github.com/folke/snacks.nvim synced 2025-07-07 13:15:08 +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-01-23 12:53:06 +00:00 • committed by github-actions[bot]
parent ada83de952
commit e2f956fd36
2 changed files with 21 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

38
docs/picker.md
View file

@ -458,6 +458,23 @@ Snacks.picker.pick({source = "files", ...})
---@field cmd? 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}
@ -534,23 +551,6 @@ 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
@ -2123,8 +2123,6 @@ Snacks.picker.actions.toggle_preview(picker)
Snacks.picker.actions.yank(_, item)
```
## 📦 `snacks.picker.core.picker`
```lua
@ -2320,3 +2318,5 @@ Get the word under the cursor or the current visual selection
```lua
picker:word()
```

4
docs/profiler.md
View file

@ -176,7 +176,7 @@ All other fields equal to `true` will match if the trace has a value for that fi
align = 80,
},
pick = {
picker = "auto", ---@type snacks.profiler.Picker
picker = "snacks", ---@type snacks.profiler.Picker
---@type snacks.profiler.Badge.type[]
badges = { "time", "count", "name" },
---@type snacks.profiler.Highlights
@ -288,7 +288,7 @@ All other fields equal to `true` will match if the trace has a value for that fi
```
```lua
---@alias snacks.profiler.Picker "auto"|"fzf-lua"|"telescope"|"trouble"
---@alias snacks.profiler.Picker "snacks"|"trouble"
---@alias snacks.profiler.Pick.spec snacks.profiler.Pick|{preset?:string}|fun():snacks.profiler.Pick
```