Based on repository activity, growth velocity and community engagement.
51
Growth18/30
Activity4/25
Popularity15/25
Trust14/20
2,713
Stars
High
Sentiment
Is this actually an AI agent?
2,713
README.md
<h1 align="center">
barbar.nvim
</h1>
<p align="center">
<b>Tabs, as understood by any other editor.</b>
</p>
barbar.nvim is a tabline plugin with re-orderable, auto-sizing, clickable tabs,
icons, nice highlighting, sort-by commands and a magic jump-to-buffer mode. Plus
the tab names are made unique when two filenames match.
In jump-to-buffer mode, tabs display a target letter instead of their icon. Jump to
any buffer by simply typing their target letter. Even better, the target letter
stays constant for the lifetime of the buffer, so if you're working with a set of
files you can even type the letter ahead from memory.
require('lazy').setup {
{'romgrk/barbar.nvim',
dependencies = {
'lewis6991/gitsigns.nvim', -- OPTIONAL: for git status
'nvim-tree/nvim-web-devicons', -- OPTIONAL: for file icons
},
init = function() vim.g.barbar_auto_setup = false end,
opts = {
-- lazy.nvim will automatically call setup for you. put your options here, anything missing will use the default:
-- animation = true,
-- insert_at_start = true,
-- …etc.
},
version = '^1.0.0', -- optional: only update when a new 1.x version is released
},
}
-- These optional plugins should be loaded directly because of a bug in Packer lazy loading
use 'nvim-tree/nvim-web-devicons' -- OPTIONAL: for file icons
use 'lewis6991/gitsigns.nvim' -- OPTIONAL: for git status
use 'romgrk/barbar.nvim'
Plug 'nvim-tree/nvim-web-devicons' " OPTIONAL: for file icons
Plug 'lewis6991/gitsigns.nvim' " OPTIONAL: for git status
Plug 'romgrk/barbar.nvim'
Features
Re-order tabs
Auto-sizing tabs, fill the space when available
Jump-to-buffer mode
Type a letter to jump to a buffer. Letters stay constant for the lifetime of the buffer.
By default, letters are assigned based on buffer name, eg README.md will get letter r.
You can change this so that letters are assigned based on usability:
home row (asdfjkl;gh) first, then other rows.
Left-click to go, middle-click or close button to close. Don't forget to set mouse+=a.
Unique names when filenames match
Pinned buffers
bbye.vim for closing buffers
A modified version of bbye.vim is included in this
plugin to close buffers without messing with your window layout and more. Available
as BufferClose and bufferline#bbye#delete(buf).
Scrollable tabs, to always show the current buffer
Offset bufferline when showing sidebars
Usage
Mappings & commands
Vim script
No default mappings are provided, here is an example. It is recommended to use
the BufferClose command to close buffers instead of bdelete because it will
not mess your window layout.
Note
In the below key mappings, the Alt key is being used.
If you are using a terminal like iTerm on Mac, you
will want to make sure that your Option key is properly
mapped to Alt. Its under Profiles > Keys, select Esc+
vim.g.barbar_auto_setup = false -- disable auto-setup
require'barbar'.setup {
-- WARN: do not copy everything below into your config!
-- It is just an example of what configuration options there are.
-- The defaults are suitable for most people.
-- Enable/disable animations
animation = true,
-- Automatically hide the tabline when there are this many buffers left.
-- Set to any value >=0 to enable.
auto_hide = false,
-- Enable/disable current/total tabpages indicator (top right corner)
tabpages = true,
-- Enables/disable clickable tabs
-- - left-click: go to buffer
-- - middle-click: delete buffer
clickable = true,
-- Excludes buffers from the tabline
exclude_ft = {'javascript'},
exclude_name = {'package.json'},
-- A buffer to this direction will be focused (if it exists) when closing the current buffer.
-- Valid options are 'left' (the default), 'previous', and 'right'
focus_on_close = 'left',
-- Hide inactive buffers and file extensions. Other options are `alternate`, `current`, and `visible`.
hide = {extensions = true, inactive = true},
-- Disable highlighting alternate buffers
highlight_alternate = false,
-- Disable highlighting file icons in inactive buffers
highlight_inactive_file_icons = false,
-- Enable highlighting visible buffers
highlight_visible = true,
icons = {
-- Configure the base icons on the bufferline.
-- Valid options to display the buffer index and -number are `true`, 'superscript' and 'subscript'
buffer_index = false,
buffer_number = false,
button = '',
-- Enables / disables diagnostic symbols
diagnostics = {
[vim.diagnostic.severity.ERROR] = {enabled = true, icon = 'ff'},
[vim.diagnostic.severity.WARN] = {enabled = false},
[vim.diagnostic.severity.INFO] = {enabled = false},
[vim.diagnostic.severity.HINT] = {enabled = true},
},
gitsigns = {
added = {enabled = true, icon = '+'},
changed = {enabled = true, icon = '~'},
deleted = {enabled = true, icon = '-'},
},
filetype = {
-- Sets the icon's highlight group.
-- If false, will use nvim-web-devicons colors
custom_colors = false,
-- Requires `nvim-web-devicons` if `true`
enabled = true,
},
separator = {left = '▎', right = ''},
-- If true, add an additional separator at the end of the buffer list
separator_at_end = true,
-- Configure the icons on the bufferline when modified or pinned.
-- Supports all the base icon options.
modified = {button = '●'},
pinned = {button = '', filename = true},
-- Use a preconfigured buffer appearance— can be 'default', 'powerline', or 'slanted'
preset = 'default',
-- Configure the icons on the bufferline based on the visibility of a buffer.
-- Supports all the base icon options, plus `modified` and `pinned`.
alternate = {filetype = {enabled = false}},
current = {buffer_index = true},
inactive = {button = '×'},
visible = {modified = {buffer_number = false}},
},
-- If true, new buffers will be inserted at the start/end of the list.
-- Default is to insert after current buffer.
insert_at_end = false,
insert_at_start = false,
-- Sets the maximum padding width with which to surround each tab
maximum_padding = 1,
-- Sets the minimum padding width with which to surround each tab
minimum_padding = 1,
-- Sets the maximum buffer name length.
maximum_length = 30,
-- Sets the minimum buffer name length.
minimum_length = 0,
-- If set, the letters for each buffer in buffer-pick mode will be
-- assigned based on their name. Otherwise or in case all letters are
-- already assigned, the behavior is to assign letters in order of
-- usability (see order below)
semantic_letters = true,
-- Set the filetypes which barbar will offset itself for
sidebar_filetypes = {
-- Use the default values: {event = 'BufWinLeave', text = '', align = 'left'}
NvimTree = true,
-- Or, specify the text used for the offset:
undotree = {
text = 'undotree',
align = 'center', -- *optionally* specify an alignment (either 'left', 'center', or 'right')
},
-- Or, specify the event which the sidebar executes when leaving:
['neo-tree'] = {event = 'BufWipeout'},
-- Or, specify all three
Outline = {event = 'BufWinLeave', text = 'symbols-outline', align = 'right'},
},
-- New buffer letters are assigned in this order. This order is
-- optimal for the qwerty keyboard layout but might need adjustment
-- for other layouts.
letters = 'asdfjkl;ghnmxcvbziowerutyqpASDFJKLGHNMXCVBZIOWERUTYQP',
-- Sets the name of unnamed buffers. By default format is "[Buffer X]"
-- where X is the buffer number. But only a static string is accepted here.
no_name_title = nil,
-- sorting options
sort = {
-- tells barbar to ignore case differences while sorting buffers
ignore_case = true,
},
}
Highlighting
Highlight groups are created in this way: Buffer<STATUS><PART>.
| <STATUS> | Meaning |
|:------------|:--------------------------------------------------------|
| Alternate | The :h alternate-file. |
| Current | The current buffer. |
| Inactive | :h hidden-buffers and :h inactive-buffers. |
| Visible | :h active-buffers which are not alternate or current. |
| <PART> | Meaning |
|:---------------|:-------------------------------------------------------------------------------------|
| ADDED | Git status added. |
| Btn | The button that shows when a buffer is unpinned and unmodified. |
| CHANGED | Git status changed. |
| DELETED | Git status deleted. |
| ERROR | Diagnostic errors. |
| HINT | Diagnostic hints. |
| Icon | The filetype icon (when icons.filetype == {custom_colors = true, enabled = true}). |
| Index | The buffer's position in the tabline. |
| INFO | Diagnostic info. |
| Mod | When the buffer is modified. |
| ModBtn | The button that shows when a buffer is modified. |
| Number | The :h bufnr(). |
| Pin | When the buffer is pinned. |
| PinBtn | The button that shows when a buffer is pinned. |
| Sign | The separator between buffers. |
| SignRight | The separator between buffers. |
| Target | The letter in buffer-pick mode. |
| WARN | Diagnostic warnings. |
e.g. the current buffer's highlight when modified is BufferCurrentMod
There are a few highlight groups which do not follow this rule. They are:
| Group | Usage |
|:--------------------|:-----------------------------------------------------------------------------------------------------------|
| BufferOffset | The background of the header for a sidebar_filetype |
| BufferScrollArrow | The arrow which shows to indicate that there are more buffers to the left or right of the scroll position. |
| BufferTabpageFill | The space between the open buffer list and the tabpage |
| BufferTabpages | The color of the tabpages indicator. |
| BufferTabpagesSep | The separator between the tabpages count. |
You can also use the doom-one.vim
colorscheme that defines those groups and is also very pleasant as you could see
in the demos above.
barbar.nvim can restore the order that your buffers were in, as well as whether a buffer was pinned. To do this, sessionoptions must contain globals, and the User SessionSavePre event must be executed before :mksession.
Barbar doesn't show up because lightline changes the tabline setting. Add:
let g:lightline={ 'enable': {'statusline': 1, 'tabline': 0} }
Netrw
netrw has a lot of bugs which make it hard to support. It may work partially, but we will not make changes to barbar.nvim to work-around netrw-specific bugs (e.g. #82).
The sidebar_filetypes option may not work as expected if your sidebar opens on startup. See nvim-tree/nvim-tree.lua#2130 for details, and romgrk/barbar.nvim#421 for a workaround.
About
Barbar is called barbar because it's a bar, but it's also more than a bar:
a "barbar".
It is pronounced like "Jar Jar" in "Jar Jar Binks", but with Bs.
No, barbar has nothing to do with barbarians.
License
barbar.nvim: Distributed under the terms of the JSON license.
bbye.vim: Distributed under the terms of the GNU Affero license.
Ecosystem Role
Standard MoltPulse indexed agent.
Embed Badge
Show off your Pulse Score in your GitHub README to build trust and rank higher.
