mirrors/snacks.nvim
1
0
Fork 0
mirror of https://github.com/folke/snacks.nvim synced 2025-08-04 10:49:08 +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-28 16:17:44 +00:00 • committed by github-actions[bot]
parent 32cffd2e60
commit e7d609b544
1 changed files with 40 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

59
docs/picker.md
View file

@ -145,6 +145,10 @@ Snacks.picker.pick({source = "files", ...})
show_always = false, -- only show the selected column when there are multiple selections
unselected = true, -- use the unselected icon for unselected items
},
severity = {
icons = true, -- show severity icons
level = false, -- show severity level
},
},
---@class snacks.picker.previewers.Config
previewers = {
@ -459,6 +463,23 @@ 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}
@ -535,23 +556,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
@ -1411,6 +1415,23 @@ vim.tbl_extend("force", {}, M.lsp_symbols, {
}
```
### `notifications`
```vim
:lua Snacks.picker.notifications(opts?)
```
```lua
---@class snacks.picker.notifications.Config: snacks.picker.Config
---@field filter? snacks.notifier.level|fun(notif: snacks.notifier.Notif): boolean
{
finder = "snacks_notifier",
format = "notification",
preview = "preview",
formatters = { severity = { level = true } },
}
```
### `picker_actions`
```vim
@ -2147,8 +2168,6 @@ Snacks.picker.actions.toggle_preview(picker)
Snacks.picker.actions.yank(_, item)
```
## 📦 `snacks.picker.core.picker`
```lua
@ -2344,3 +2363,5 @@ Get the word under the cursor or the current visual selection
```lua
picker:word()
```