mirror of
https://github.com/folke/snacks.nvim
synced 2025-08-03 18:28:38 +00:00
chore(build): auto-generate docs
This commit is contained in:
parent
7d655fe09d
commit
d56cd48e4c
2 changed files with 29 additions and 28 deletions
|
@ -88,7 +88,8 @@ Snacks.image.supports(file)
|
|||
### `image:convert()`
|
||||
|
||||
```lua
|
||||
image:convert()
|
||||
---@param file string
|
||||
image:convert(file)
|
||||
```
|
||||
|
||||
### `image:create()`
|
||||
|
@ -97,19 +98,16 @@ image:convert()
|
|||
image:create()
|
||||
```
|
||||
|
||||
### `image:dim()`
|
||||
### `image:grid_size()`
|
||||
|
||||
```lua
|
||||
---@param win number
|
||||
---@return snacks.image.Dim
|
||||
image:dim(win)
|
||||
image:grid_size()
|
||||
```
|
||||
|
||||
### `image:hide()`
|
||||
|
||||
```lua
|
||||
---@param win? number
|
||||
image:hide(win)
|
||||
image:hide()
|
||||
```
|
||||
|
||||
### `image:ready()`
|
||||
|
@ -120,9 +118,12 @@ image:ready()
|
|||
|
||||
### `image:render()`
|
||||
|
||||
Renders the unicode placeholder grid in the buffer
|
||||
|
||||
```lua
|
||||
---@param win number
|
||||
image:render(win)
|
||||
---@param width number
|
||||
---@param height number
|
||||
image:render(width, height)
|
||||
```
|
||||
|
||||
### `image:request()`
|
||||
|
|
|
@ -596,23 +596,6 @@ 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}
|
||||
|
@ -689,6 +672,23 @@ 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
|
||||
|
@ -2646,6 +2646,8 @@ Snacks.picker.actions.toggle_preview(picker)
|
|||
Snacks.picker.actions.yank(picker, item, action)
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 📦 `snacks.picker.core.picker`
|
||||
|
||||
```lua
|
||||
|
@ -2879,5 +2881,3 @@ 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