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
17bdd182f7
commit
e3cd699931
2 changed files with 23 additions and 20 deletions
|
@ -38,7 +38,9 @@ FEATURES *snacks.nvim-snacks.nvim-features*
|
|||
dim Focus on the active scope by dimming
|
||||
the rest
|
||||
|
||||
git Git utilities
|
||||
explorer A file explorer (picker in disguise)
|
||||
|
||||
git Gitutilities
|
||||
|
||||
gitbrowse Open the current file, branch,
|
||||
commit, or repo in a browser
|
||||
|
@ -166,6 +168,7 @@ Default Options ~
|
|||
---@field bigfile? snacks.bigfile.Config
|
||||
---@field dashboard? snacks.dashboard.Config
|
||||
---@field dim? snacks.dim.Config
|
||||
---@field explorer? snacks.explorer.Config
|
||||
---@field gitbrowse? snacks.gitbrowse.Config
|
||||
---@field indent? snacks.indent.Config
|
||||
---@field input? snacks.input.Config
|
||||
|
|
|
@ -481,6 +481,23 @@ 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.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}
|
||||
|
@ -557,23 +574,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
|
||||
|
@ -2321,8 +2321,6 @@ Snacks.picker.actions.vsplit()
|
|||
Snacks.picker.actions.yank(_, item)
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 📦 `snacks.picker.core.picker`
|
||||
|
||||
```lua
|
||||
|
@ -2531,3 +2529,5 @@ 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