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

Browse source
This commit is contained in:
folke 2025-10-20 18:09:27 +00:00 • committed by github-actions[bot]
parent 6af1e76758
commit 3fd2acb72d
2 changed files with 24 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/input.md
View file

@ -94,12 +94,16 @@ docs for more information on how to customize these styles
---@alias snacks.input.Pos "left"|"title"|false
```
```lua
---@alias snacks.input.Highlight {[1]:number, [2]:number, [3]:string}
```
```lua
---@class snacks.input.Opts: snacks.input.Config,{}
---@field prompt? string
---@field default? string
---@field completion? string
---@field highlight? fun()
---@field highlight? fun(text: string): snacks.input.Highlight[]
```
## 📦 Module

38
docs/picker.md
View file

@ -620,6 +620,23 @@ 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}
@ -699,23 +716,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
@ -2748,8 +2748,6 @@ Snacks.picker.actions.toggle_preview(picker)
Snacks.picker.actions.yank(picker, item, action)
```
## 📦 `snacks.picker.core.picker`
```lua
@ -3004,3 +3002,5 @@ Get the word under the cursor or the current visual selection
```lua
picker:word()
```