snacks.nvim/docs/statuscolumn.md
Folke Lemaitre 7434770804 docs: docgen
2024-11-14 23:56:37 +01:00

39 lines
735 B
Markdown

# 🍿 statuscolumn
<!-- docgen -->
## ⚙️ Config
```lua
---@class snacks.statuscolumn.Config
---@field enabled? boolean
{
left = { "mark", "sign" }, -- priority of signs on the left (high to low)
right = { "fold", "git" }, -- priority of signs on the right (high to low)
folds = {
open = false, -- show open fold icons
git_hl = false, -- use Git Signs hl for fold icons
},
git = {
-- patterns to match Git signs
patterns = { "GitSign", "MiniDiffSign" },
},
refresh = 50, -- refresh at most every 50ms
}
```
## 📦 Module
### `Snacks.statuscolumn()`
```lua
---@type fun(): string
Snacks.statuscolumn()
```
### `Snacks.statuscolumn.get()`
```lua
---@return string
Snacks.statuscolumn.get()
```