Dich0tomy / nvim-headband

πŸ±β€πŸ‘€ A simple and opinionated winbar

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Do not use this plugin :p

I made this decision a few weeks ago and revoked it, but after further consideration I will not main nvim-headband (the plugin will be archived).

I originally made this plugin right before winbar went into master, in a couple of days, not thinking of any architecture, without prior bigger experience and with barely any sleep, which resulted in a plugin that isn't well considered and full of bugs. The best I can do to this plugin is almost completely rewrite it, but I don't really fancy to do so, I'd like to direct my attention into other projects I think would be more valuable to the community. There are already plugins out there that do the same (but better), like barbecue.nvim and statusline plugins have a winbar feature as well.

nvim-headband..

  • is simple - you can just install it, call setup and you are good to go
  • is opinionated - it doesn't give you all the possible cofiguration options in the world, it has two simple sections
  • has sane defaults - it's very likely that you won't have to change the default configuration

.. but it's still highly configurable! See Configuration and Highlights.

πŸ–Ό Showcase

I'd like me a winbar! Winbar default Although I'd like to see a little bit more of the path.. Winbar with shortened path Hmmm.. And it'd be nice if the location was on the right! Winbar with location on the right Ooooh! And I like bubbles, wonder if.. Winbar with bubbles

Perfect!
All the above and more preconfigured winbars can be found here.

πŸ’Ύ Installation

Install with your favourite package manager, e.g. https://github.com/wbthomason/packer.nvim:

use {
  'B4mbus/nvim-headband',
  config = function()
    require('nvim-headband').setup {
      -- Your configuration goes here
    }
  end,
  after = 'nvim-web-devicons',
  requires = {
    { 'SmiteshP/nvim-navic' } -- required for for the navic section to work
    { 'kyazdani42/nvim-web-devicons' } -- required for for devicons and default location_section.separator highlight group
  }
}

βš™ Configuration

See Configuration & Usage.

🎨 Highlights

See Configuration & Usage - Highlights.

πŸ”œ Soon

  1. For shortened paths an option to make them full for a second (:toogle_short()?)
  2. Clickable and hoverable items in sections (directories, location items)
  3. Make unsaved_buffer a section like file_section so that it's easier to configure it's behavior
  4. Vim docs
  5. Add an option to center both sections

About

πŸ±β€πŸ‘€ A simple and opinionated winbar

License:MIT License


Languages

Language:Lua 100.0%