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-16 08:55:15 +00:00 • committed by github-actions[bot]
parent cc69043689
commit b89ac2548c
1 changed files with 22 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

22
docs/picker.md
View file

@ -419,6 +419,17 @@ Generic filter used by finders to pre-filter items
---@field ignorecase? boolean use ignorecase (defaults to true)
```
This is only used when using `opts.preview = "preview"`.
It's a previewer that shows a preview based on the item data.
```lua
---@class snacks.picker.Item.preview
---@field text string text to show in the preview buffer
---@field ft? string optional filetype used tohighlight the preview buffer
---@field extmarks? snacks.picker.Extmark[] additional extmarks
---@field loc? boolean set to false to disable showing the item location in the preview
```
```lua
---@class snacks.picker.Item
---@field [string] any
@ -429,6 +440,7 @@ Generic filter used by finders to pre-filter items
---@field pos? {[1]:number, [2]:number}
---@field end_pos? {[1]:number, [2]:number}
---@field highlights? snacks.picker.Highlight[][]
---@field preview? snacks.picker.Item.preview
```
```lua
@ -672,6 +684,16 @@ Neovim commands
}
```
### `git_diff`
```lua
{
finder = "git_diff",
format = "file",
preview = "preview",
}
```
### `git_files`
Find git files