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
27cba535a6
commit
b098f0d8dc
2 changed files with 68 additions and 17 deletions
|
@ -1,4 +1,4 @@
|
|||
*snacks.nvim.txt* For Neovim Last change: 2025 February 04
|
||||
*snacks.nvim.txt* For Neovim Last change: 2025 February 05
|
||||
|
||||
==============================================================================
|
||||
Table of Contents *snacks.nvim-table-of-contents*
|
||||
|
|
|
@ -225,6 +225,14 @@ Snacks.picker.pick({source = "files", ...})
|
|||
["<c-s>"] = { "edit_split", mode = { "i", "n" } },
|
||||
["<c-u>"] = { "list_scroll_up", mode = { "i", "n" } },
|
||||
["<c-v>"] = { "edit_vsplit", mode = { "i", "n" } },
|
||||
["<c-z>h"] = { "layout_left", mode = { "i", "n" } },
|
||||
["<c-z><c-h>"] = { "layout_left", mode = { "i", "n" } },
|
||||
["<c-z>j"] = { "layout_bottom", mode = { "i", "n" } },
|
||||
["<c-z><c-j>"] = { "layout_bottom", mode = { "i", "n" } },
|
||||
["<c-z>k"] = { "layout_top", mode = { "i", "n" } },
|
||||
["<c-z><c-k>"] = { "layout_top", mode = { "i", "n" } },
|
||||
["<c-z>l"] = { "layout_right", mode = { "i", "n" } },
|
||||
["<c-z><c-l>"] = { "layout_right", mode = { "i", "n" } },
|
||||
["?"] = "toggle_help_input",
|
||||
["G"] = "list_bottom",
|
||||
["gg"] = "list_top",
|
||||
|
@ -266,6 +274,14 @@ Snacks.picker.pick({source = "files", ...})
|
|||
["<c-s>"] = "edit_split",
|
||||
["<c-u>"] = "list_scroll_up",
|
||||
["<c-v>"] = "edit_vsplit",
|
||||
["<c-z>h"] = { "layout_left", mode = { "i", "n" } },
|
||||
["<c-z><c-h>"] = { "layout_left", mode = { "i", "n" } },
|
||||
["<c-z>j"] = { "layout_bottom", mode = { "i", "n" } },
|
||||
["<c-z><c-j>"] = { "layout_bottom", mode = { "i", "n" } },
|
||||
["<c-z>k"] = { "layout_top", mode = { "i", "n" } },
|
||||
["<c-z><c-k>"] = { "layout_top", mode = { "i", "n" } },
|
||||
["<c-z>l"] = { "layout_right", mode = { "i", "n" } },
|
||||
["<c-z><c-l>"] = { "layout_right", mode = { "i", "n" } },
|
||||
["?"] = "toggle_help_list",
|
||||
["G"] = "list_bottom",
|
||||
["gg"] = "list_top",
|
||||
|
@ -553,20 +569,8 @@ Snacks.picker.pick({source = "files", ...})
|
|||
```
|
||||
|
||||
```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}
|
||||
---@class snacks.picker.layout.Action: snacks.picker.Action
|
||||
---@field layout? snacks.picker.layout.Config|string
|
||||
```
|
||||
|
||||
```lua
|
||||
|
@ -645,6 +649,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
|
||||
|
@ -1920,6 +1941,12 @@ Open a project from zoxide
|
|||
|
||||
## 🖼️ Layouts
|
||||
|
||||
### `bottom`
|
||||
|
||||
```lua
|
||||
{ preset = "ivy", layout = { position = "bottom" } }
|
||||
```
|
||||
|
||||
### `default`
|
||||
|
||||
```lua
|
||||
|
@ -2013,6 +2040,18 @@ Open a project from zoxide
|
|||
}
|
||||
```
|
||||
|
||||
### `left`
|
||||
|
||||
```lua
|
||||
M.sidebar
|
||||
```
|
||||
|
||||
### `right`
|
||||
|
||||
```lua
|
||||
{ preset = "sidebar", layout = { position = "right" } }
|
||||
```
|
||||
|
||||
### `select`
|
||||
|
||||
```lua
|
||||
|
@ -2088,6 +2127,12 @@ Open a project from zoxide
|
|||
}
|
||||
```
|
||||
|
||||
### `top`
|
||||
|
||||
```lua
|
||||
{ preset = "ivy", layout = { position = "top" } }
|
||||
```
|
||||
|
||||
### `vertical`
|
||||
|
||||
```lua
|
||||
|
@ -2240,6 +2285,12 @@ Snacks.picker.actions.item_action(picker, item, action)
|
|||
Snacks.picker.actions.jump(picker, _, action)
|
||||
```
|
||||
|
||||
### `Snacks.picker.actions.layout()`
|
||||
|
||||
```lua
|
||||
Snacks.picker.actions.layout(picker, _, action)
|
||||
```
|
||||
|
||||
### `Snacks.picker.actions.lcd()`
|
||||
|
||||
```lua
|
||||
|
@ -2461,6 +2512,8 @@ Snacks.picker.actions.toggle_preview(picker)
|
|||
Snacks.picker.actions.yank(_, item)
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 📦 `snacks.picker.core.picker`
|
||||
|
||||
```lua
|
||||
|
@ -2694,5 +2747,3 @@ 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