Awesome

heirline-components.nvim

Distro agnostic components for your Neovim heirline config.

This is how the components above look on the statusline.

Table of contents

• Why
• How to install
• How to use
• Example config
• Components
• Available options
• Events (optional)
• FAQ

Why

Heirline is a engine to create your own Neovim user interface. This comes at a price though: increased complexity. To avoid that problem, I've decided to compile this collection of components you can fork and modify. That way you have a safe and well tested starting point to hopefuly save you a lot of time.

How to install

Add it as a dependency of heirline

{
  "rebelot/heirline.nvim",
  dependencies = { "Zeioth/heirline-components.nvim" }
  opts = {},
    config = function(_, opts)
      local heirline = require "heirline"
      local heirline_components = require "heirline-components.all"

      -- Setup
      heirline_components.init.subscribe_to_events()
      heirline.load_colors(heirline_components.hl.get_colors())
      heirline.setup(opts)
    end,
}

Some extra features will only be available if you have the next plugins installed:

• lewis6991/gitsigns.nvim
• nvim-telescope/telescope.nvim
• zeioth/compiler.nvim
• mfussenegger/nvim-dap
• echasnovski/mini.bufremove
• nvim-neo-tree/neo-tree.nvim
• stevearc/aerial.nvim
• folke/zen-mode.nvim
• linux-cultist/venv-selector.nvim

How to use

You can add a component to your heirline config as

require("heirline-components.all").component.some_component()

Normally you will use components directly like in this example. But in some cases you can customize a component. Refer to every specific component for more info.

Example config

You can find the example config we use for NormalNvim here.

Components

Tabline components

This is the heirline line you see at the top of the screen.

You can control the tabline from your keymappings with heirline-components.buffer.

Winbar components

This is the heirline line you see under the tabline.

Statuscolumn components

This is the heirline column you see at the left of the screen.

Statusline components

This is the heirline line you see at the bottom of the screen.

Available options

You can customize icons and colors in a easy way.

For example:

"rebelot/heirline.nvim",
dependencies = {
  {
    "Zeioth/heirline-components.nvim",
    opts = {
      icons = { DiagnosticError = ";D" }
      colors = nil
    }
  }
}

Events (Optional)

Heirline-components listen for two different events:

So if you experience issues with colors or outdated tabline info, trigger these events with :doautocmd.

Credits

Currently, most of the GPL3 lua components this plugin use come from AstroNvim and NormalNvim. So please support both projects if you enjoy this plugin.

FAQ

• How can I contribute with a component? Clone this repo. Go to core.component.lua and create yours there. Then open a PR.
• How do components work? A component is made of providers. So you can use providers to build your component. Aditionally, conditions are used to decide when a component should be displayed. These components have been tested on nvim v0.10+
• How can I avoid breaking changes? Always use the components by importing heirline-components.all. That way internal changes won't affect you. If you wanna be extra sure, you can also lock the plugin version in your package manager to avoid getting updates.

🌟 Support the project

If you want to help me, please star this repository to increase the visibility of the project.