Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/famiu/feline.nvim
A minimal, stylish and customizable statusline for Neovim written in Lua
https://github.com/famiu/feline.nvim
lua neovim neovim-plugin nvim statusline
Last synced: about 2 months ago
JSON representation
A minimal, stylish and customizable statusline for Neovim written in Lua
- Host: GitHub
- URL: https://github.com/famiu/feline.nvim
- Owner: famiu
- License: gpl-3.0
- Archived: true
- Created: 2021-04-13T11:08:16.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-20T18:18:39.000Z (12 months ago)
- Last Synced: 2024-07-14T20:16:13.568Z (2 months ago)
- Topics: lua, neovim, neovim-plugin, nvim, statusline
- Language: Lua
- Homepage:
- Size: 423 KB
- Stars: 1,035
- Watchers: 5
- Forks: 55
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- my-awesome-github-stars - famiu/feline.nvim - A minimal, stylish and customizable statusline for Neovim written in Lua (Lua)
README
# feline.nvim
A minimal, stylish and customizable statusline / winbar for Neovim written in Lua
Requires Neovim >= 0.7 (or >= 0.5 with the `0.5-compat` branch)
## About
Feline is a Lua statusline plugin that prioritizes speed, customizability and minimalism. It's fast and never gets in your way. Feline only provides you with the necessary tools that you need to customize the statusline to your liking and avoids feature-bloat. It's also extremely customizable and allows you to configure it in any way you wish to. Feline also has reasonable defaults for those who don't want to configure things and just want a good out of the box experience.
## Features
- Ease-of-use.
- Complete customizability over every component.
- [Built-in providers](USAGE.md#default-providers) such as:
- Vi-mode
- File info
- Cursor position
- Diagnostics (using [Neovim's built-in LSP](https://neovim.io/doc/user/lsp.html))
- Git branch and diffs (using [gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim/))
and many more
- Minimalistic, only provides the bare minimum and allows the user to build their own components very easily.
- Winbar support.
## Requirements
- Necessary
- Neovim v0.7 or greater (v0.5 or greater if using the `0.5-compat` branch)
- You must have 24-bit RGB color enabled in Neovim (do `:help 'termguicolors'` in Neovim for more info)
- Optional
- Neovim v0.8 or greater - For winbar support
- [nvim-web-devicons](https://github.com/kyazdani42/nvim-web-devicons/) - For icon support
- [A patched font](https://github.com/ryanoasis/nerd-fonts/) - For icon support
- [gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim/) - For [git providers](#git)
## Screenshots
**NOTE: Some of these configurations may be outdated and may need to be changed prior to use. A few of the configurations are missing a link because the link to them was removed due to the link no longer being valid.**
**Default setup:**
**Default no-icons setup:**
**[Config by crivotz:](https://github.com/crivotz/nv-ide/blob/master/lua/plugins/feline.lua)**
**[Config by 6cdh:](https://github.com/6cdh/dotfiles/blob/62959d27344dade28d6dd638252cd82accb309ab/nvim/.config/nvim/lua/statusline.lua)**
**Config by luizcoro2:**
**Config by rafamadriz (classic):**
**Gruvbox:**
**Nord:**
**Config by rafamadriz (slant):**
**Gruvbox:**
**Nord:**
**Config by rafamadriz (VSCode):**
**[Config by pianocomposer321:](https://gist.github.com/pianocomposer321/6151c458132a97590d21415db67361a6)**
**[Config by iBhagwan:](https://github.com/ibhagwan/nvim-lua/blob/main/lua/plugins/feline.lua)**
**[Config by EdenEast](https://github.com/EdenEast/nyx/blob/8a9819e/config/.config/nvim/lua/eden/modules/ui/feline/init.lua)** (Colors generated from applied colorscheme)
**Nightfox**
**Dayfox**
**[Config by toufyx](https://gist.github.com/Toufyx/d6b48a0a12ceff02268be49db0a97ddf)**
**[Config by Hitesh-Aggarwal](https://github.com/Hitesh-Aggarwal/feline_one_monokai.nvim/blob/2ff798d4d0435d2145593587dc93a70e72a6d279/plugin/feline_one_monokai.lua)**
**[Config by Dharmx](https://gist.github.com/dharmx/47139967b0c4303572e3742af725300c)**
You can add your own configuration to this list. If you're interested, simply make a [Pull Request](CONTRIBUTING.md) and I'll add it.
## Installation
- [packer.nvim](https://github.com/wbthomason/packer.nvim/):
```lua
use 'feline-nvim/feline.nvim'
```
- [vim-plug](https://github.com/junegunn/vim-plug/):
```vim
Plug 'feline-nvim/feline.nvim'
```
### Using a compatibility branch
Feline has compatibility branches which are versions that have compatibility with an older Neovim version. The compatibility branches are old and usually don't contain the latest changes to Feline, though the changes may occasionally be backported. However, these branches are useful if you don't have the currently required minimum version of Neovim to use Feline. The compatibility branches are named like `{neovim-version}-compat` where `{neovim-version}` is the version of Neovim it maintains compatibility with. For example, the `0.5-compat` branch is compatible with Neovim 0.5. Note that there may not be a compatibility branch for all versions and there may be gaps in the compatibility versions. Here's how you can install a compatibility branch instead of the master branch:
- [packer.nvim](https://github.com/wbthomason/packer.nvim/):
```lua
use { 'feline-nvim/feline.nvim', branch = '0.5-compat' }
```
- [vim-plug](https://github.com/junegunn/vim-plug/):
```vim
Plug 'feline-nvim/feline.nvim', { 'branch': '0.5-compat' }
```
Compatibility branches for versions that are 4 or more (minor) versions older than the latest Neovim version may be removed at any time, so use them at your own risk.
## Getting started
### Using the default configuration
Once you've installed Feline, it's extremely easy to get started with it. If you don't mind using the default settings, you can just call Feline's `setup()` function in your configuration. Like this:
```lua
require('feline').setup()
```
And that's it! It's as easy as that. If you want to set up the `'winbar'` alongside the statusline, just add this line next to the previous line:
```lua
require('feline').winbar.setup()
```
### Configuring Feline to fit your needs
If the default configuration doesn't fit your needs and you want to build your own statusline configuration, it's highly recommended to configure Feline to suit your needs. The only prerequisite is knowing the basics of Lua. Feline provides a ton of configuration options which can let you build your statusline exactly how you want it as long. To see how to do that, take a look at [USAGE](USAGE.md) or use `:help feline.txt` inside Neovim to read the USAGE documentation.
## Help
### Common issues
#### Feline crashes or disappears for seemingly no reason
This can be caused if you forget to remove your other statusline plugins after installing Feline. Make sure all other statusline plugins are removed before you install Feline, that should fix the issue.
### Reporting issues or feature requests
If you have an issue that you can't find the fix to in the documentation or want to request a feature you think is absolutely necessary, feel free to make a new [Issue](https://github.com/feline-nvim/feline.nvim/issues) and I will try my best to look into it. If you want to contribute to Feline, you can make a Pull Request. For more details, please see: [CONTRIBUTING](CONTRIBUTING.md)
## Why Feline?
Now, you might be thinking, why do we need another statusline plugin? We've already got a bunch of brilliant statusline plugins like galaxyline, airline, lualine, expressline etc. and all of them are excellent. So then, why Feline?
I'd like to preface this by saying that what I'm about to say can be (and probably is) very biased and opinionated. Take what's being said here with a grain of salt. All of this is purely my opinion and not a fact by any means, so it's fine to disagree. Moreover, any statement I make here may be incorrect or outdated. In which case, please feel free to make an [Issue or Pull Request](CONTRIBUTING.md) correcting it.
I think that despite those plugins being neat, each have their own shortcomings. I find those shortcomings as too much to ignore. For example, most of the statusline plugins are not very customizable and the plugins only provide a limited amount of tools and options for customization. Feline, on the other hand, is built for customizability from the ground up. You are not limited in any way by what the plugin provides. You can control every individual component and its location, appearance, everything about it.
Feline is also fast and never gets in your way. It lazy-loads most of its modules, which allows it to start up instantly. Statusline updates with Feline are also blazing fast, which provides for a really smooth experience.
Feline is minimal and only implements the bare minimum required for you to get started. It both expects and invites you to make your own components and providers, because nobody understands you better than yourself. To help you do that, Feline provides all the tools and options you would need while also giving you a solid foundation to build from. One could say that the real goal of Feline is to make creating your own statusline as easy for you as possible, while also providing reasonable defaults that should be enough for most people.
Documentation is another aspect where I found most statusline plugins to be very lacking. Feline is extremely easy to configure and well-documented, which allows anyone to be able to build their statusline as they wish to. It provides example for every option to allow anyone to easily understand the purpose of any option
Lastly, anyone is welcome to contribute to Feline, either by making an Issue or through a Pull Request (see [CONTRIBUTING](CONTRIBUTING.md) for further information). Any kind of contribution starting from fixing a minor typo to adding a massive new feature is welcome.
And this plugin is named after cats, you won't get that anywhere else.
## LICENSE
Feline is licensed under GNU GPLv3. For more info, see: [LICENSE.md](LICENSE.md).
## Miscellaneous
### Naming
The name of this plugin is a silly pun based on the convention of the names of statusline plugins ending with 'line', while also being named after cats. And in a way this statusline is supposed to be as quick as a cat's instincts, so I guess the name fits.