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-02-02 21:05:39 +00:00 • committed by github-actions[bot]
parent 5a2056575f
commit b6a84db919
1 changed files with 25 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

44
docs/picker.md
View file

@ -489,6 +489,23 @@ Snacks.picker.pick({source = "files", ...})
---@field cmd? snacks.picker.EditCmd
```
```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}
@ -565,23 +582,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
@ -1631,6 +1631,12 @@ Open recent projects
confirm = "load_session",
patterns = { ".git", "_darcs", ".hg", ".bzr", ".svn", "package.json", "Makefile" },
recent = true,
matcher = {
frecency = true, -- use frecency boosting
sort_empty = true, -- sort even when the filter is empty
cwd_bonus = false,
},
sort = { fields = { "score:desc", "idx" } },
win = {
preview = { minimal = true },
input = {
@ -2401,8 +2407,6 @@ Snacks.picker.actions.toggle_preview(picker)
Snacks.picker.actions.yank(_, item)
```
## 📦 `snacks.picker.core.picker`
```lua
@ -2626,3 +2630,5 @@ Get the word under the cursor or the current visual selection
```lua
picker:word()
```