mirror of
https://github.com/folke/snacks.nvim
synced 2025-07-07 13:15:08 +00:00
chore(build): auto-generate docs
This commit is contained in:
parent
b1db65ac61
commit
698daf7cdf
3 changed files with 25 additions and 19 deletions
|
@ -578,6 +578,23 @@ Snacks.picker.pick({source = "files", ...})
|
|||
---@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
|
||||
---@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}
|
||||
|
@ -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
|
||||
```
|
||||
|
||||
```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
|
||||
|
@ -2538,8 +2538,6 @@ Snacks.picker.actions.toggle_preview(picker)
|
|||
Snacks.picker.actions.yank(_, item)
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 📦 `snacks.picker.core.picker`
|
||||
|
||||
```lua
|
||||
|
@ -2773,3 +2771,5 @@ Get the word under the cursor or the current visual selection
|
|||
```lua
|
||||
picker:word()
|
||||
```
|
||||
|
||||
|
||||
|
|
|
@ -296,6 +296,9 @@ The other options are used with `:lua Snacks.dashboard()`
|
|||
wo = {
|
||||
winhighlight = "NormalFloat:Normal",
|
||||
},
|
||||
w = {
|
||||
snacks_main = true,
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
|
|
|
@ -91,6 +91,9 @@ docs for more information on how to customize these styles
|
|||
wo = {
|
||||
winhighlight = "NormalFloat:Normal",
|
||||
},
|
||||
w = {
|
||||
snacks_main = true,
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue