mirror of
https://github.com/folke/snacks.nvim
synced 2025-08-04 02:38:46 +00:00
chore(build): auto-generate docs
This commit is contained in:
parent
64026877ad
commit
ab3595a3f6
1 changed files with 16 additions and 11 deletions
|
@ -126,6 +126,10 @@ Snacks.picker.pick({source = "files", ...})
|
|||
file = {
|
||||
filename_first = false, -- display filename before the file path
|
||||
},
|
||||
selected = {
|
||||
show_always = false, -- only show the selected column when there are multiple selections
|
||||
unselected = true, -- use the unselected icon for unselected items
|
||||
},
|
||||
},
|
||||
---@class snacks.picker.previewers.Config
|
||||
previewers = {
|
||||
|
@ -250,6 +254,7 @@ Snacks.picker.pick({source = "files", ...})
|
|||
ui = {
|
||||
live = " ",
|
||||
selected = "● ",
|
||||
unselected = "○ ",
|
||||
-- selected = " ",
|
||||
},
|
||||
git = {
|
||||
|
@ -409,15 +414,6 @@ Snacks.picker.pick({source = "files", ...})
|
|||
|
||||
## 📚 Types
|
||||
|
||||
```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.Extmark vim.api.keyset.set_extmark|{col:number, row?:number, field?:string}
|
||||
---@alias snacks.picker.Text {[1]:string, [2]:string?, virtual?:boolean, field?:string}
|
||||
|
@ -486,6 +482,15 @@ It's a previewer that shows a preview based on the item data.
|
|||
---@field preview? snacks.win.Config|{} preview window config
|
||||
```
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
## 📦 Module
|
||||
|
||||
```lua
|
||||
|
@ -1713,6 +1718,8 @@ Snacks.picker.actions.toggle_maximize(picker)
|
|||
Snacks.picker.actions.toggle_preview(picker)
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 📦 `snacks.picker.core.picker`
|
||||
|
||||
```lua
|
||||
|
@ -1869,5 +1876,3 @@ Get the word under the cursor or the current visual selection
|
|||
```lua
|
||||
picker:word()
|
||||
```
|
||||
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue