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
Some checks failed
CI / ci (push) Failing after 0s
Details

Browse source
This commit is contained in:
folke 2025-02-04 22:48:40 +00:00 • committed by github-actions[bot]
parent 1839c65f67
commit eac06ed1a5
1 changed files with 20 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

40
docs/picker.md
View file

@ -552,6 +552,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}
@ -617,7 +634,7 @@ It's a previewer that shows a preview based on the item data.
---@field reverse? boolean when true, the list will be reversed (bottom-up)
---@field fullscreen? boolean open in fullscreen
---@field cycle? boolean cycle through the list
---@field preview? boolean|"main" show preview window in the picker or the main window
---@field preview? boolean|"main"|{enabled?:boolean, main?:boolean} show preview window in the picker or the main window
---@field preset? string|fun(source:string):string
```
@ -628,23 +645,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
@ -2461,8 +2461,6 @@ Snacks.picker.actions.toggle_preview(picker)
Snacks.picker.actions.yank(_, item)
```
## 📦 `snacks.picker.core.picker`
```lua
@ -2696,3 +2694,5 @@ Get the word under the cursor or the current visual selection
```lua
picker:word()
```