mirror of
https://github.com/folke/snacks.nvim
synced 2025-08-04 02:38:46 +00:00
chore(build): auto-generate docs
This commit is contained in:
parent
eebf44a34e
commit
c07497d591
3 changed files with 30 additions and 0 deletions
|
@ -94,6 +94,12 @@ layout:close(opts)
|
|||
layout:each(cb, opts)
|
||||
```
|
||||
|
||||
### `layout:hide()`
|
||||
|
||||
```lua
|
||||
layout:hide()
|
||||
```
|
||||
|
||||
### `layout:is_enabled()`
|
||||
|
||||
Check if the window has been used in the layout
|
||||
|
@ -137,6 +143,12 @@ Toggle a window
|
|||
layout:toggle(win)
|
||||
```
|
||||
|
||||
### `layout:unhide()`
|
||||
|
||||
```lua
|
||||
layout:unhide()
|
||||
```
|
||||
|
||||
### `layout:valid()`
|
||||
|
||||
Check if layout is valid (visible)
|
||||
|
|
|
@ -330,6 +330,7 @@ Snacks.picker.pick({source = "files", ...})
|
|||
---@class snacks.picker.debug
|
||||
debug = {
|
||||
scores = false, -- show scores in the list
|
||||
leaks = false, -- show when pickers don't get garbage collected
|
||||
},
|
||||
}
|
||||
```
|
||||
|
@ -511,6 +512,10 @@ 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
|
||||
|
@ -1962,6 +1967,13 @@ and then`vim.schedule` the callback.
|
|||
picker:norm(cb)
|
||||
```
|
||||
|
||||
### `picker:ref()`
|
||||
|
||||
```lua
|
||||
---@return snacks.Picker.ref
|
||||
picker:ref()
|
||||
```
|
||||
|
||||
### `picker:resolve()`
|
||||
|
||||
```lua
|
||||
|
|
|
@ -269,6 +269,12 @@ win:buf_valid()
|
|||
win:close(opts)
|
||||
```
|
||||
|
||||
### `win:destroy()`
|
||||
|
||||
```lua
|
||||
win:destroy()
|
||||
```
|
||||
|
||||
### `win:dim()`
|
||||
|
||||
```lua
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue