Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/echasnovski/mini.statusline
Neovim Lua plugin with minimal and fast statusline. Part of 'mini.nvim' library.
https://github.com/echasnovski/mini.statusline
lua mini-nvim neovim neovim-plugin
Last synced: 2 days ago
JSON representation
Neovim Lua plugin with minimal and fast statusline. Part of 'mini.nvim' library.
- Host: GitHub
- URL: https://github.com/echasnovski/mini.statusline
- Owner: echasnovski
- License: mit
- Created: 2022-10-24T16:29:00.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-12T18:27:11.000Z (3 months ago)
- Last Synced: 2024-08-12T21:37:10.512Z (3 months ago)
- Topics: lua, mini-nvim, neovim, neovim-plugin
- Language: Lua
- Homepage:
- Size: 75.2 KB
- Stars: 22
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/echasnovski/mini.nvim/blob/main/LICENSE)
### Minimal and fast statusline module with opinionated default look
See more details in [Features](#features) and [help file](doc/mini-statusline.txt).
---
⦿ This is a part of [mini.nvim](https://github.com/echasnovski/mini.nvim) library. Please use [this link](https://github.com/echasnovski/mini.nvim/blob/main/README.md) if you want to mention this module.
⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.
⦿ See the repository page to learn about common design principles and configuration recipes.
---
If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://github.com/echasnovski/mini.nvim/blob/main/CONTRIBUTING.md) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.
## Demo
https://user-images.githubusercontent.com/24854248/173045208-42463c8f-a2ac-488d-9d30-216891f4bb51.mp4
## Features
- Define own custom statusline structure for active and inactive windows. This is done with a function which should return string appropriate for |statusline|. Its code should be similar to default one with structure:
- Compute string data for every section you want to be displayed.
- Combine them in groups with `MiniStatusline.combine_groups()`.
- Built-in active mode indicator with colors.
- Sections can hide information when window is too narrow (specific window width is configurable per section).
## Dependencies
For full experience needs (still works without any of suggestions):
- [Nerd font](https://www.nerdfonts.com/) and enabled ['mini.icons'](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-icons.md) module to show filetype icons. Can fall back to using [nvim-tree/nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons) plugin.
- Enabled ['mini.git'](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-git.md) and ['mini.diff'](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-diff.md) modules to show Git and diff related information. Can fall back to using [lewis6991/gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim) plugin.
## Installation
This plugin can be installed as part of 'mini.nvim' library (**recommended**) or as a standalone Git repository.
There are two branches 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).
- `stable` will be updated only upon releases with code tested during public beta-testing phase in `main` branch.
Here are code snippets for some common installation methods (use only one):
With mini.deps
Github repo
Branch Code snippet
'mini.nvim' library Main Follow recommended 'mini.deps' installation
Stable
Standalone plugin Main add('echasnovski/mini.statusline')
Stable add({ source = 'echasnovski/mini.statusline', checkout = 'stable' })
With folke/lazy.nvim
Github repo
Branch Code snippet
'mini.nvim' library
Main { 'echasnovski/mini.nvim', version = false },
Stable { 'echasnovski/mini.nvim', version = '*' },
Standalone plugin
Main { 'echasnovski/mini.statusline', version = false },
Stable { 'echasnovski/mini.statusline', version = '*' },
With junegunn/vim-plug
Github repo
Branch Code snippet
'mini.nvim' library
Main Plug 'echasnovski/mini.nvim'
Stable Plug 'echasnovski/mini.nvim', { 'branch': 'stable' }
Standalone plugin Main Plug 'echasnovski/mini.statusline'
Stable Plug 'echasnovski/mini.statusline', { 'branch': 'stable' }
**Important**: don't forget to call `require('mini.statusline').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.
{
-- Content of statusline as functions which return statusline string. See
-- `:h statusline` and code of default contents (used instead of `nil`).
content = {
-- Content for active window
active = nil,
-- Content for inactive window(s)
inactive = nil,
},
-- Whether to use icons by default
use_icons = true,
-- Whether to set Vim's settings for statusline (make it always shown)
set_vim_settings = true,
}
```
## Similar plugins
- [nvim-lualine/lualine.nvim](https://github.com/nvim-lualine/lualine.nvim)