mirrors/snacks.nvim
1
0
Fork 0
mirror of https://github.com/folke/snacks.nvim synced 2025-08-04 18:58:12 +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-19 14:08:54 +00:00 • committed by github-actions[bot]
parent e146a66cb7
commit 8127fddc57
2 changed files with 22 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/image.md
View file

@ -145,9 +145,9 @@ In case of issues, make sure to run `:checkhealth snacks`.
---@type table<string,snacks.image.args>
magick = {
default = { "{src}[0]", "-scale", "1920x1080>" }, -- default for raster images
vector = { "-density", 300, "{src}[0]" }, -- used by vector images like svg
math = { "-density", 300, "{src}[0]", "-trim" },
pdf = { "-density", 300, "{src}[0]", "-background", "white", "-alpha", "remove", "-trim" },
vector = { "-density", 192, "{src}[0]" }, -- used by vector images like svg
math = { "-density", 192, "{src}[0]", "-trim" },
pdf = { "-density", 192, "{src}[0]", "-background", "white", "-alpha", "remove", "-trim" },
},
},
}

38
docs/picker.md
View file

@ -609,23 +609,6 @@ Snacks.picker.pick({source = "files", ...})
---@field notify? boolean
```
```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}
@ -704,6 +687,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
@ -2706,6 +2706,8 @@ Snacks.picker.actions.toggle_preview(picker)
Snacks.picker.actions.yank(picker, item, action)
```
## 📦 `snacks.picker.core.picker`
```lua
@ -2960,5 +2962,3 @@ Get the word under the cursor or the current visual selection
```lua
picker:word()
```