mirror of
https://github.com/folke/snacks.nvim
synced 2025-07-07 13:15:08 +00:00
chore(build): auto-generate docs
This commit is contained in:
parent
3d695ab7d0
commit
cc04806393
2 changed files with 23 additions and 21 deletions
|
@ -619,23 +619,6 @@ Snacks.picker.pick({source = "files", ...})
|
|||
---@field expr 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}
|
||||
|
@ -714,6 +697,23 @@ 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
|
||||
|
@ -1066,8 +1066,10 @@ Neovim commands
|
|||
```
|
||||
|
||||
```lua
|
||||
---@type snacks.picker.git.Config
|
||||
---@class snacks.picker.git.branches.Config: snacks.picker.git.Config
|
||||
---@field all? boolean show all branches, including remote
|
||||
{
|
||||
all = false,
|
||||
finder = "git_branches",
|
||||
format = "git_branch",
|
||||
preview = "git_log",
|
||||
|
@ -2729,6 +2731,8 @@ Snacks.picker.actions.toggle_preview(picker)
|
|||
Snacks.picker.actions.yank(picker, item, action)
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 📦 `snacks.picker.core.picker`
|
||||
|
||||
```lua
|
||||
|
@ -2983,5 +2987,3 @@ Get the word under the cursor or the current visual selection
|
|||
```lua
|
||||
picker:word()
|
||||
```
|
||||
|
||||
|
||||
|
|
|
@ -11,7 +11,7 @@
|
|||
---@field diagnostics_buffer fun(opts?: snacks.picker.diagnostics.Config|{}): snacks.Picker
|
||||
---@field explorer fun(opts?: snacks.picker.explorer.Config|{}): snacks.Picker
|
||||
---@field files fun(opts?: snacks.picker.files.Config|{}): snacks.Picker
|
||||
---@field git_branches fun(opts?: snacks.picker.git.Config|{}): snacks.Picker
|
||||
---@field git_branches fun(opts?: snacks.picker.git.branches.Config|{}): snacks.Picker
|
||||
---@field git_diff fun(opts?: snacks.picker.git.Config|{}): snacks.Picker
|
||||
---@field git_files fun(opts?: snacks.picker.git.files.Config|{}): snacks.Picker
|
||||
---@field git_grep fun(opts?: snacks.picker.git.grep.Config|{}): snacks.Picker
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue