mirror of
https://github.com/folke/snacks.nvim
synced 2025-07-07 21:25:11 +00:00
chore(build): auto-generate docs
This commit is contained in:
parent
2b38a19dc9
commit
0ccf97c6e1
2 changed files with 16 additions and 15 deletions
|
@ -120,6 +120,7 @@ vim.api.nvim_create_autocmd("LspProgress", {
|
||||||
---@class snacks.notifier.Config
|
---@class snacks.notifier.Config
|
||||||
---@field enabled? boolean
|
---@field enabled? boolean
|
||||||
---@field keep? fun(notif: snacks.notifier.Notif): boolean # global keep function
|
---@field keep? fun(notif: snacks.notifier.Notif): boolean # global keep function
|
||||||
|
---@field filter? fun(notif: snacks.notifier.Notif): boolean # filter our unwanted notifications (return false to hide)
|
||||||
{
|
{
|
||||||
timeout = 3000, -- default timeout in ms
|
timeout = 3000, -- default timeout in ms
|
||||||
width = { min = 40, max = 0.4 },
|
width = { min = 40, max = 0.4 },
|
||||||
|
|
|
@ -441,19 +441,6 @@ Snacks.picker.pick({source = "files", ...})
|
||||||
---@field cmd? string
|
---@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
|
```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}
|
||||||
|
@ -526,6 +513,19 @@ 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
|
||||||
|
```
|
||||||
|
|
||||||
## 📦 Module
|
## 📦 Module
|
||||||
|
|
||||||
```lua
|
```lua
|
||||||
|
@ -1825,6 +1825,8 @@ Snacks.picker.actions.toggle_maximize(picker)
|
||||||
Snacks.picker.actions.toggle_preview(picker)
|
Snacks.picker.actions.toggle_preview(picker)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 📦 `snacks.picker.core.picker`
|
## 📦 `snacks.picker.core.picker`
|
||||||
|
|
||||||
```lua
|
```lua
|
||||||
|
@ -2017,5 +2019,3 @@ Get the word under the cursor or the current visual selection
|
||||||
```lua
|
```lua
|
||||||
picker:word()
|
picker:word()
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue