mirrors/snacks.nvim
1
0
Fork 0
mirror of https://github.com/folke/snacks.nvim synced 2025-08-03 18:28:38 +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-02-05 19:02:55 +00:00 • committed by github-actions[bot]
parent 8676c409e1
commit 1bbc8f90fd
1 changed files with 39 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

58
docs/picker.md
View file

@ -577,23 +577,6 @@ Snacks.picker.pick({source = "files", ...})
---@field layout? snacks.picker.layout.Config|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}
@ -670,6 +653,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
@ -1005,6 +1005,14 @@ Neovim commands
format = "git_branch",
preview = "git_log",
confirm = "git_checkout",
win = {
input = {
keys = {
["<c-a>"] = { "git_branch_add", mode = { "n", "i" } },
["<c-x>"] = { "git_branch_del", mode = { "n", "i" } },
},
},
},
on_show = function(picker)
for i, item in ipairs(picker:items()) do
if item.current then
@ -2235,6 +2243,18 @@ Snacks.picker.actions.focus_list(picker)
Snacks.picker.actions.focus_preview(picker)
```
### `Snacks.picker.actions.git_branch_add()`
```lua
Snacks.picker.actions.git_branch_add(picker)
```
### `Snacks.picker.actions.git_branch_del()`
```lua
Snacks.picker.actions.git_branch_del(picker, item)
```
### `Snacks.picker.actions.git_checkout()`
```lua
@ -2516,6 +2536,8 @@ Snacks.picker.actions.toggle_preview(picker)
Snacks.picker.actions.yank(_, item)
```
## 📦 `snacks.picker.core.picker`
```lua
@ -2749,5 +2771,3 @@ Get the word under the cursor or the current visual selection
```lua
picker:word()
```