mirrors/snacks.nvim
1
0
Fork 0
mirror of https://github.com/folke/snacks.nvim synced 2025-08-04 18:58:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

chore(build): auto-generate docs

Browse source
This commit is contained in:
folke 2025-01-23 09:52:22 +00:00 • committed by github-actions[bot]
parent 97898e910d
commit 24899315af
1 changed files with 49 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

74
docs/picker.md
View file

@ -457,23 +457,6 @@ Snacks.picker.pick({source = "files", ...})
---@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
---@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}
@ -550,6 +533,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
@ -1041,6 +1041,24 @@ Neovim help tags
}
```
### `icons`
```vim
:lua Snacks.picker.icons(opts?)
```
```lua
---@class snacks.picker.icons.Config: snacks.picker.Config
---@field icons? string[]
{
icons = { "nerd_fonts", "emoji" },
finder = "icons",
format = "icon",
layout = { preset = "vscode" },
confirm = "put",
}
```
### `jumps`
```vim
@ -1787,12 +1805,6 @@ Snacks.picker.actions.bufdelete(picker)
Snacks.picker.actions.cmd(picker, item)
```
### `Snacks.picker.actions.copy()`
```lua
Snacks.picker.actions.copy(_, item)
```
### `Snacks.picker.actions.cycle_win()`
```lua
@ -1971,6 +1983,12 @@ Snacks.picker.actions.preview_scroll_right(picker)
Snacks.picker.actions.preview_scroll_up(picker)
```
### `Snacks.picker.actions.put()`
```lua
Snacks.picker.actions.put(picker, item)
```
### `Snacks.picker.actions.qflist()`
Send selected or all items to the quickfix list.
@ -2062,6 +2080,14 @@ Snacks.picker.actions.toggle_maximize(picker)
Snacks.picker.actions.toggle_preview(picker)
```
### `Snacks.picker.actions.yank()`
```lua
Snacks.picker.actions.yank(_, item)
```
## 📦 `snacks.picker.core.picker`
```lua
@ -2257,5 +2283,3 @@ Get the word under the cursor or the current visual selection
```lua
picker:word()
```