### Statuscolumn
See more details in [Features](#features) and [Documentation](../doc/mini-statuscolumn.txt).
---
⦿ This is a part of [mini.nvim](https://nvim-mini.org/mini.nvim) library. Please use [this link](https://nvim-mini.org/mini.nvim/readmes/mini-statuscolumn) if you want to mention this module.
⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.
⦿ See [whole library documentation](https://nvim-mini.org/mini.nvim/doc/mini-nvim) to learn about general design principles, disable/configuration recipes, and more.
---
If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://nvim-mini.org/mini.nvim/CONTRIBUTING) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.
## Demo
https://github.com/user-attachments/assets/63ed48eb-9fdf-4b59-b190-bbdc10fd28d9
## Features
- Fast [`'statuscolumn'`](https://neovim.io/doc/user/helptag.html?tag='statuscolumn') with improved defaults.
- Fully customizable content via functions that take precomputed useful data.
- `:h MiniStatuscolumn.gen_content.main()` for simplified customization.
- Automatic dimming inside inactive windows content.
Notes:
- Works best on Neovim>=0.11.
- Default content follows the behavior defined by options for the built-in statuscolumn sections. Like `'number'`, `'signcolumn'`, `'foldcolumn'`, etc.
## Installation
This plugin can be installed as part of 'mini.nvim' library (**recommended**) or as a standalone Git repository.
During beta-testing phase there is only one branch to install from:
- `main` (default, **recommended**) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled).
Here are code snippets for some common installation methods (use only one):
(Recommended) With vim.pack (on Neovim 0.12 and newer)
**Full library**
Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
**Standalone plugin**
Main branch:
```lua
vim.pack.add({ 'https://github.com/nvim-mini/mini.statuscolumn' })
```
With mini.deps (before Neovim 0.12)
**Full library**
Follow [recommended 'mini.deps' installation](https://nvim-mini.org/mini.nvim/readmes/mini-deps#installation).
**Standalone plugin**:
Main branch:
```lua
add('nvim-mini/mini.statuscolumn')
```
With folke/lazy.nvim
**Full library**
Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
**Standalone plugin**
Main branch:
```lua
{ 'nvim-mini/mini.statuscolumn', version = false },
```
**Important**: don't forget to call `require('mini.statuscolumn').setup()` to enable its functionality.
**Note**: if you are on Windows, there might be problems with too long file paths (like `error: unable to create file : Filename too long`). Try doing one of the following:
- Enable corresponding git global config value: `git config --system core.longpaths true`. Then try to reinstall.
- Install plugin in other place with shorter path.
## Default config
```lua
-- No need to copy this inside `setup()`. Will be used automatically.
{
-- Statuscolumn content as functions that return statusline-like string
content = {
-- Content of an active window
active = nil,
-- Content of an inactive window
inactive = nil,
},
-- Whether to dim column content in inactive windows
dim_inactive = true,
}
```
## Similar plugins
- [luukvball/statuscol.nvim](https://github.com/luukvbaal/statuscol.nvim):
- A framework with building blocks and configuration: custom sections, sign filters, fold functions.
While this module aims to provide a performant `'statuscolumn'` with a sensible default with a limited (yet enough) customization and an entry point to building own `'statuscolumn'`.
- [folke/snacks.nvim#statuscolumn](https://github.com/folke/snacks.nvim/blob/main/docs/statuscolumn.md):
- An opinionated `'statuscolumn'` implementation with a limited customization.
While this module provides more opportunities for building custom implementation and more customization.