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-01-20 11:15:51 +00:00 • committed by github-actions[bot]
parent 32cd34383c
commit 9b6b11fbf2
2 changed files with 16 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/dashboard.md
View file

@ -623,7 +623,7 @@ Get the most recent files, optionally filtered by the
current working directory or a custom directory.
```lua
---@param opts? {limit?:number, cwd?:string|boolean}
---@param opts? {limit?:number, cwd?:string|boolean, filter?:fun(file:string):boolean?}
---@return snacks.dashboard.Gen
Snacks.dashboard.sections.recent_files(opts)
```

30
docs/picker.md
View file

@ -441,6 +441,19 @@ 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.Extmark vim.api.keyset.set_extmark|{col:number, row?:number, field?:string}
---@alias snacks.picker.Text {[1]:string, [2]:string?, virtual?:boolean, field?:string}
@ -513,19 +526,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
```
## 📦 Module
```lua
@ -1825,8 +1825,6 @@ Snacks.picker.actions.toggle_maximize(picker)
Snacks.picker.actions.toggle_preview(picker)
```
## 📦 `snacks.picker.core.picker`
```lua
@ -2019,3 +2017,5 @@ Get the word under the cursor or the current visual selection
```lua
picker:word()
```