mirror of
https://github.com/folke/snacks.nvim
synced 2025-12-23 08:47:57 +00:00
chore(build): auto-generate docs
This commit is contained in:
parent
42902871f5
commit
f27b8b313e
2 changed files with 54 additions and 18 deletions
|
|
@ -77,6 +77,7 @@ Table of Contents *snacks.nvim-picker-table-of-contents*
|
|||
- select |snacks.nvim-picker-sources-select|
|
||||
- smart |snacks.nvim-picker-sources-smart|
|
||||
- spelling |snacks.nvim-picker-sources-spelling|
|
||||
- tags |snacks.nvim-picker-sources-tags|
|
||||
- treesitter |snacks.nvim-picker-sources-treesitter|
|
||||
- undo |snacks.nvim-picker-sources-undo|
|
||||
- zoxide |snacks.nvim-picker-sources-zoxide|
|
||||
|
|
@ -836,6 +837,14 @@ TROUBLE *snacks.nvim-picker-examples-trouble*
|
|||
---@field expr string
|
||||
<
|
||||
|
||||
>lua
|
||||
---@alias snacks.Picker.ref (fun():snacks.Picker?)|{value?: snacks.Picker}
|
||||
<
|
||||
|
||||
>lua
|
||||
---@alias snacks.picker.history.Record {pattern: string, search: string, live?: boolean}
|
||||
<
|
||||
|
||||
>lua
|
||||
---@alias snacks.picker.format.resolve fun(max_width:number):snacks.picker.Highlight[]
|
||||
---@alias snacks.picker.Extmark vim.api.keyset.set_extmark|{col:number, row?:number, field?:string}
|
||||
|
|
@ -917,14 +926,6 @@ 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
|
||||
---@alias snacks.picker.history.Record {pattern: string, search: string, live?: boolean}
|
||||
<
|
||||
|
||||
|
||||
==============================================================================
|
||||
7. Module *snacks.nvim-picker-module*
|
||||
|
|
@ -2377,6 +2378,24 @@ SPELLING *snacks.nvim-picker-sources-spelling*
|
|||
<
|
||||
|
||||
|
||||
TAGS *snacks.nvim-picker-sources-tags*
|
||||
|
||||
>vim
|
||||
:lua Snacks.picker.tags(opts?)
|
||||
<
|
||||
|
||||
Search tags file
|
||||
|
||||
>lua
|
||||
---@class snacks.picker.tags.Config: snacks.picker.Config
|
||||
{
|
||||
workspace = true, -- search tags in the workspace
|
||||
finder = "vim_tags",
|
||||
format = "lsp_symbol",
|
||||
}
|
||||
<
|
||||
|
||||
|
||||
TREESITTER *snacks.nvim-picker-sources-treesitter*
|
||||
|
||||
>vim
|
||||
|
|
|
|||
|
|
@ -639,6 +639,14 @@ Snacks.picker.pick({source = "files", ...})
|
|||
---@field expr string
|
||||
```
|
||||
|
||||
```lua
|
||||
---@alias snacks.Picker.ref (fun():snacks.Picker?)|{value?: snacks.Picker}
|
||||
```
|
||||
|
||||
```lua
|
||||
---@alias snacks.picker.history.Record {pattern: string, search: string, live?: boolean}
|
||||
```
|
||||
|
||||
```lua
|
||||
---@alias snacks.picker.format.resolve fun(max_width:number):snacks.picker.Highlight[]
|
||||
---@alias snacks.picker.Extmark vim.api.keyset.set_extmark|{col:number, row?:number, field?:string}
|
||||
|
|
@ -720,14 +728,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
|
||||
---@alias snacks.picker.history.Record {pattern: string, search: string, live?: boolean}
|
||||
```
|
||||
|
||||
## 📦 Module
|
||||
|
||||
```lua
|
||||
|
|
@ -2114,6 +2114,23 @@ Not meant to be used directly.
|
|||
}
|
||||
```
|
||||
|
||||
### `tags`
|
||||
|
||||
```vim
|
||||
:lua Snacks.picker.tags(opts?)
|
||||
```
|
||||
|
||||
Search tags file
|
||||
|
||||
```lua
|
||||
---@class snacks.picker.tags.Config: snacks.picker.Config
|
||||
{
|
||||
workspace = true, -- search tags in the workspace
|
||||
finder = "vim_tags",
|
||||
format = "lsp_symbol",
|
||||
}
|
||||
```
|
||||
|
||||
### `treesitter`
|
||||
|
||||
```vim
|
||||
|
|
@ -2838,8 +2855,6 @@ Snacks.picker.actions.toggle_preview(picker)
|
|||
Snacks.picker.actions.yank(picker, item, action)
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 📦 `snacks.picker.core.picker`
|
||||
|
||||
```lua
|
||||
|
|
@ -3094,3 +3109,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