mirror of
https://github.com/folke/snacks.nvim
synced 2025-08-04 18:58:12 +00:00
114 lines
2.7 KiB
Text
114 lines
2.7 KiB
Text
*snacks.nvim-statuscolumn.txt* For Neovim Last change: 2024 November 05
|
|
|
|
==============================================================================
|
|
Table of Contents *snacks.nvim-statuscolumn-table-of-contents*
|
|
|
|
1. statuscolumn |snacks.nvim-statuscolumn-statuscolumn|
|
|
- Config |snacks.nvim-statuscolumn-statuscolumn-config|
|
|
- Types |snacks.nvim-statuscolumn-statuscolumn-types|
|
|
- Module |snacks.nvim-statuscolumn-statuscolumn-module|
|
|
|
|
==============================================================================
|
|
1. statuscolumn *snacks.nvim-statuscolumn-statuscolumn*
|
|
|
|
|
|
CONFIG *snacks.nvim-statuscolumn-statuscolumn-config*
|
|
|
|
>lua
|
|
---@class snacks.statuscolumn.Config
|
|
{
|
|
left = { "mark", "sign" },
|
|
right = { "fold", "git" },
|
|
folds = {
|
|
open = false, -- show open fold icons
|
|
git_hl = false, -- use Git Signs hl for fold icons
|
|
},
|
|
git = {
|
|
patterns = { "GitSign", "MiniDiffSign" },
|
|
},
|
|
refresh = 50, -- refresh at most every 50ms
|
|
}
|
|
<
|
|
|
|
|
|
TYPES *snacks.nvim-statuscolumn-statuscolumn-types*
|
|
|
|
>lua
|
|
---@alias snacks.statuscolumn.Sign.type "mark"|"sign"|"fold"|"git"
|
|
---@alias snacks.statuscolumn.Sign {name:string, text:string, texthl:string, priority:number, type:snacks.statuscolumn.Sign.type}
|
|
<
|
|
|
|
|
|
MODULE *snacks.nvim-statuscolumn-statuscolumn-module*
|
|
|
|
>lua
|
|
---@class snacks.statuscolumn
|
|
Snacks.statuscolumn = {}
|
|
<
|
|
|
|
|
|
SNACKS.STATUSCOLUMN() ~
|
|
|
|
>lua
|
|
---@type fun(): string
|
|
Snacks.statuscolumn()
|
|
<
|
|
|
|
|
|
SNACKS.STATUSCOLUMN.BUF_SIGNS() ~
|
|
|
|
Returns a list of regular and extmark signs sorted by priority (low to high)
|
|
|
|
>lua
|
|
---@return table<number, snacks.statuscolumn.Sign[]>
|
|
---@param buf number
|
|
Snacks.statuscolumn.buf_signs(buf)
|
|
<
|
|
|
|
|
|
SNACKS.STATUSCOLUMN.GET() ~
|
|
|
|
>lua
|
|
Snacks.statuscolumn.get()
|
|
<
|
|
|
|
|
|
SNACKS.STATUSCOLUMN.ICON() ~
|
|
|
|
>lua
|
|
---@param sign? snacks.statuscolumn.Sign
|
|
---@param len? number
|
|
Snacks.statuscolumn.icon(sign, len)
|
|
<
|
|
|
|
|
|
SNACKS.STATUSCOLUMN.IS_GIT_SIGN() ~
|
|
|
|
>lua
|
|
---@param name string
|
|
Snacks.statuscolumn.is_git_sign(name)
|
|
<
|
|
|
|
|
|
SNACKS.STATUSCOLUMN.LINE_SIGNS() ~
|
|
|
|
Returns a list of regular and extmark signs sorted by priority (high to low)
|
|
|
|
>lua
|
|
---@return snacks.statuscolumn.Sign[]
|
|
---@param win number
|
|
---@param buf number
|
|
---@param lnum number
|
|
Snacks.statuscolumn.line_signs(win, buf, lnum)
|
|
<
|
|
|
|
|
|
SNACKS.STATUSCOLUMN.SETUP() ~
|
|
|
|
>lua
|
|
Snacks.statuscolumn.setup()
|
|
<
|
|
|
|
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
|
|
|
|
vim:tw=78:ts=8:noet:ft=help:norl:
|