mirror of
https://github.com/folke/snacks.nvim
synced 2025-08-04 18:58:12 +00:00
chore(build): auto-generate docs
This commit is contained in:
parent
b5b0995e8b
commit
f346d297dd
4 changed files with 22 additions and 19 deletions
|
@ -129,6 +129,7 @@ Please refer to the readme of each plugin for their specific configuration.
|
|||
---@field words? snacks.words.Config
|
||||
---@field zen? snacks.zen.Config
|
||||
---@field styles? table<string, snacks.win.Config>
|
||||
---@field image? snacks.image.Config|{}
|
||||
{
|
||||
image = {
|
||||
-- define these here, so that we don't need to load the image module
|
||||
|
|
|
@ -195,6 +195,7 @@ Default Options ~
|
|||
---@field words? snacks.words.Config
|
||||
---@field zen? snacks.zen.Config
|
||||
---@field styles? table<string, snacks.win.Config>
|
||||
---@field image? snacks.image.Config|{}
|
||||
{
|
||||
image = {
|
||||
-- define these here, so that we don't need to load the image module
|
||||
|
|
|
@ -31,6 +31,7 @@
|
|||
---@field words? snacks.words.Config
|
||||
---@field zen? snacks.zen.Config
|
||||
---@field styles? table<string, snacks.win.Config>
|
||||
---@field image? snacks.image.Config|{}
|
||||
{
|
||||
image = {
|
||||
-- define these here, so that we don't need to load the image module
|
||||
|
|
|
@ -605,6 +605,23 @@ 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}
|
||||
|
@ -683,23 +700,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
|
||||
|
@ -2693,8 +2693,6 @@ Snacks.picker.actions.toggle_preview(picker)
|
|||
Snacks.picker.actions.yank(picker, item, action)
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 📦 `snacks.picker.core.picker`
|
||||
|
||||
```lua
|
||||
|
@ -2949,3 +2947,5 @@ Get the word under the cursor or the current visual selection
|
|||
```lua
|
||||
picker:word()
|
||||
```
|
||||
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue