https://github.com/Dich0tomy/nvim-headband

🐱‍👤 A simple and opinionated winbar
https://github.com/Dich0tomy/nvim-headband

lua neovim neovim-plugin nvim winbar

Last synced: 24 days ago
JSON representation

🐱‍👤 A simple and opinionated winbar

• Host: GitHub
• URL: https://github.com/Dich0tomy/nvim-headband
• Owner: Dich0tomy
• License: mit
• Archived: true
• Created: 2022-08-23T11:49:52.000Z (almost 2 years ago)
• Default Branch: trunk
• Last Pushed: 2023-01-01T22:07:40.000Z (over 1 year ago)
• Last Synced: 2024-05-02T06:03:41.243Z (about 2 months ago)
• Topics: lua, neovim, neovim-plugin, nvim, winbar
• Language: Lua
• Homepage:
• Size: 414 KB
• Stars: 31
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-stars - Dich0tomy/nvim-headband - 🐱‍👤 A simple and opinionated winbar (Lua)
• awesome-stars - Dich0tomy/nvim-headband - 🐱‍👤 A simple and opinionated winbar (Lua)

README

        
# 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**](https://github.com/utilyre/barbecue.nvim) and statusline plugins have a winbar feature as well.



# nvim-headband - a simple and opinionated winbar

  


    🖼 Showcase |

    💾 Installation |

    ⚙ Configuration & Usage |

    🎨 Highlights |

    🧾 Todo

  



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](#-Configuration) and [Highlights](#-Highlights).

## 🖼 Showcase

I'd like me a winbar!

![Winbar default](../media/default.png)

Although I'd like to see a little bit more of the path..

![Winbar with shortened path](../media/shortened_path.png)

Hmmm.. And it'd be nice if the location was on the right!

![Winbar with location on the right](../media/location_on_right.png)

Ooooh! And I like bubbles, wonder if..

![Winbar with bubbles](../media/bubbles.png)

Perfect!  



All the above and more preconfigured winbars can be [**found here**](PRECONFIGURED_WINBARS.md).



## 💾 Installation

Install with your favourite package manager, e.g. **[https://github.com/wbthomason/packer.nvim](packer)**:

```lua

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](CONFIGURATION_AND_USAGE.md).

## 🎨 Highlights

See [Configuration & Usage - Highlights](CONFIGURATION_AND_USAGE.md#-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