mirror of
https://github.com/folke/snacks.nvim
synced 2025-12-23 08:47:57 +00:00
chore(build): auto-generate docs
This commit is contained in:
parent
8272c1c66f
commit
ff1ac4bd81
2 changed files with 29 additions and 22 deletions
|
|
@ -596,6 +596,23 @@ Snacks.picker.pick({source = "files", ...})
|
|||
---@field field? 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}
|
||||
|
|
@ -672,23 +689,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
|
||||
|
|
@ -720,10 +720,11 @@ Snacks.picker()
|
|||
|
||||
### `Snacks.picker.get()`
|
||||
|
||||
Get active pickers, optionally filtered by source
|
||||
Get active pickers, optionally filtered by source,
|
||||
or the current tab
|
||||
|
||||
```lua
|
||||
---@param opts? {source?: string}
|
||||
---@param opts? {source?: string, tab?: boolean} tab defaults to true
|
||||
Snacks.picker.get(opts)
|
||||
```
|
||||
|
||||
|
|
@ -2647,8 +2648,6 @@ Snacks.picker.actions.toggle_preview(picker)
|
|||
Snacks.picker.actions.yank(picker, item, action)
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 📦 `snacks.picker.core.picker`
|
||||
|
||||
```lua
|
||||
|
|
@ -2680,7 +2679,7 @@ local M = {}
|
|||
### `Snacks.picker.picker.get()`
|
||||
|
||||
```lua
|
||||
---@param opts? {source?: string}
|
||||
---@param opts? {source?: string, tab?: boolean}
|
||||
Snacks.picker.picker.get(opts)
|
||||
```
|
||||
|
||||
|
|
@ -2882,3 +2881,5 @@ Get the word under the cursor or the current visual selection
|
|||
```lua
|
||||
picker:word()
|
||||
```
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -349,6 +349,12 @@ win:map()
|
|||
win:on(event, cb, opts)
|
||||
```
|
||||
|
||||
### `win:on_current_tab()`
|
||||
|
||||
```lua
|
||||
win:on_current_tab()
|
||||
```
|
||||
|
||||
### `win:on_resize()`
|
||||
|
||||
```lua
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue