![\"demo\"](\"./static/demo.gif\")
barbar.nvim is a tabline plugin with re-orderable, auto-sizing, clickable tabs,\nicons, nice highlighting, sort-by commands and a magic jump-to-buffer mode. Plus\nthe 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\nany buffer by simply typing their target letter. Even better, the target letter\nstays constant for the lifetime of the buffer, so if you're working with a set of\nfiles you can even type the letter ahead from memory.
\nRequirements:
\nOptional Requirements:
\nrequire('lazy').setup {\n {'romgrk/barbar.nvim',\n dependencies = {\n 'lewis6991/gitsigns.nvim', -- OPTIONAL: for git status\n 'nvim-tree/nvim-web-devicons', -- OPTIONAL: for file icons\n },\n init = function() vim.g.barbar_auto_setup = false end,\n opts = {\n -- lazy.nvim will automatically call setup for you. put your options here, anything missing will use the default:\n -- animation = true,\n -- insert_at_start = true,\n -- …etc.\n },\n version = '^1.0.0', -- optional: only update when a new 1.x version is released\n },\n}\n-- These optional plugins should be loaded directly because of a bug in Packer lazy loading\nuse 'nvim-tree/nvim-web-devicons' -- OPTIONAL: for file icons\nuse 'lewis6991/gitsigns.nvim' -- OPTIONAL: for git status\nuse 'romgrk/barbar.nvim'\nPlug 'lewis6991/gitsigns.nvim' \" OPTIONAL: for git status\nPlug 'nvim-tree/nvim-web-devicons' \" OPTIONAL: for file icons\nPlug 'romgrk/barbar.nvim'\n![\"reorder\"](\"./static/reorder.gif\")
![\"resize\"](\"./static/resize.gif\")
![\"jump\"](\"./static/jump.gif\")
Type a letter to jump to a buffer. Letters stay constant for the lifetime of the buffer.\nBy default, letters are assigned based on buffer name, eg README.md will get letter r.\nYou can change this so that letters are assigned based on usability:\nhome row (asdfjkl;gh) first, then other rows.
![\"jump\"](\"./static/sort.gif\")
:BufferOrderByDirectory, :BufferOrderByLanguage, :BufferOrderByWindowNumber, :BufferOrderByBufferNumber
![\"click\"](\"./static/click.gif\")
Left-click to go, middle-click or close button to close. Don't forget to set mouse+=a.
![\"unique-name\"](\"./static/unique-name.png\")
![\"pinned\"](\"./static/pinned.png\")
A modified version of bbye.vim is included in this\nplugin to close buffers without messing with your window layout and more. Available\nas BufferClose and bufferline#bbye#delete(buf).
![\"scroll\"](\"./static/scroll.gif\")
![\"filetree-with-offset\"](\"./static/filetree-with-offset.png\")
No default mappings are provided, here is an example. It is recommended to use\nthe BufferClose command to close buffers instead of bdelete because it will\nnot mess your window layout.
\" Move to previous/next\nnnoremap <silent> <A-,> <Cmd>BufferPrevious<CR>\nnnoremap <silent> <A-.> <Cmd>BufferNext<CR>\n\n\" Re-order to previous/next\nnnoremap <silent> <A-<> <Cmd>BufferMovePrevious<CR>\nnnoremap <silent> <A->> <Cmd>BufferMoveNext<CR>\n\n\" Goto buffer in position...\nnnoremap <silent> <A-1> <Cmd>BufferGoto 1<CR>\nnnoremap <silent> <A-2> <Cmd>BufferGoto 2<CR>\nnnoremap <silent> <A-3> <Cmd>BufferGoto 3<CR>\nnnoremap <silent> <A-4> <Cmd>BufferGoto 4<CR>\nnnoremap <silent> <A-5> <Cmd>BufferGoto 5<CR>\nnnoremap <silent> <A-6> <Cmd>BufferGoto 6<CR>\nnnoremap <silent> <A-7> <Cmd>BufferGoto 7<CR>\nnnoremap <silent> <A-8> <Cmd>BufferGoto 8<CR>\nnnoremap <silent> <A-9> <Cmd>BufferGoto 9<CR>\nnnoremap <silent> <A-0> <Cmd>BufferLast<CR>\n\n\" Pin/unpin buffer\nnnoremap <silent> <A-p> <Cmd>BufferPin<CR>\n\n\" Close buffer\nnnoremap <silent> <A-c> <Cmd>BufferClose<CR>\n\" Restore buffer\nnnoremap <silent> <A-s-c> <Cmd>BufferRestore<CR>\n\n\" Wipeout buffer\n\" :BufferWipeout\n\" Close commands\n\" :BufferCloseAllButCurrent\n\" :BufferCloseAllButVisible\n\" :BufferCloseAllButPinned\n\" :BufferCloseAllButCurrentOrPinned\n\" :BufferCloseBuffersLeft\n\" :BufferCloseBuffersRight\n\n\" Magic buffer-picking mode\nnnoremap <silent> <C-p> <Cmd>BufferPick<CR>\nnnoremap <silent> <C-p> <Cmd>BufferPickDelete<CR>\n\n\" Sort automatically by...\nnnoremap <silent> <Space>bb <Cmd>BufferOrderByBufferNumber<CR>\nnnoremap <silent> <Space>bd <Cmd>BufferOrderByDirectory<CR>\nnnoremap <silent> <Space>bl <Cmd>BufferOrderByLanguage<CR>\nnnoremap <silent> <Space>bw <Cmd>BufferOrderByWindowNumber<CR>\n\n\" Other:\n\" :BarbarEnable - enables barbar (enabled by default)\n\" :BarbarDisable - very bad command, should never be used\nlocal map = vim.api.nvim_set_keymap\nlocal opts = { noremap = true, silent = true }\n\n-- Move to previous/next\nmap('n', '<A-,>', '<Cmd>BufferPrevious<CR>', opts)\nmap('n', '<A-.>', '<Cmd>BufferNext<CR>', opts)\n-- Re-order to previous/next\nmap('n', '<A-<>', '<Cmd>BufferMovePrevious<CR>', opts)\nmap('n', '<A->>', '<Cmd>BufferMoveNext<CR>', opts)\n-- Goto buffer in position...\nmap('n', '<A-1>', '<Cmd>BufferGoto 1<CR>', opts)\nmap('n', '<A-2>', '<Cmd>BufferGoto 2<CR>', opts)\nmap('n', '<A-3>', '<Cmd>BufferGoto 3<CR>', opts)\nmap('n', '<A-4>', '<Cmd>BufferGoto 4<CR>', opts)\nmap('n', '<A-5>', '<Cmd>BufferGoto 5<CR>', opts)\nmap('n', '<A-6>', '<Cmd>BufferGoto 6<CR>', opts)\nmap('n', '<A-7>', '<Cmd>BufferGoto 7<CR>', opts)\nmap('n', '<A-8>', '<Cmd>BufferGoto 8<CR>', opts)\nmap('n', '<A-9>', '<Cmd>BufferGoto 9<CR>', opts)\nmap('n', '<A-0>', '<Cmd>BufferLast<CR>', opts)\n-- Pin/unpin buffer\nmap('n', '<A-p>', '<Cmd>BufferPin<CR>', opts)\n-- Close buffer\nmap('n', '<A-c>', '<Cmd>BufferClose<CR>', opts)\n-- Wipeout buffer\n-- :BufferWipeout\n-- Close commands\n-- :BufferCloseAllButCurrent\n-- :BufferCloseAllButPinned\n-- :BufferCloseAllButCurrentOrPinned\n-- :BufferCloseBuffersLeft\n-- :BufferCloseBuffersRight\n-- Magic buffer-picking mode\nmap('n', '<C-p>', '<Cmd>BufferPick<CR>', opts)\n-- Sort automatically by...\nmap('n', '<Space>bb', '<Cmd>BufferOrderByBufferNumber<CR>', opts)\nmap('n', '<Space>bd', '<Cmd>BufferOrderByDirectory<CR>', opts)\nmap('n', '<Space>bl', '<Cmd>BufferOrderByLanguage<CR>', opts)\nmap('n', '<Space>bw', '<Cmd>BufferOrderByWindowNumber<CR>', opts)\n\n-- Other:\n-- :BarbarEnable - enables barbar (enabled by default)\n-- :BarbarDisable - very bad command, should never be used\n\n\nNote
\nIf you're using Vim Script, just wrap
\nsetuplike this:\nlet g:barbar_auto_setup = v:false \" disable auto-setup\nlua << EOF\n require'barbar'.setup {…}\nEOF\n
vim.g.barbar_auto_setup = false -- disable auto-setup\n\nrequire'barbar'.setup {\n -- WARN: do not copy everything below into your config!\n -- It is just an example of what configuration options there are.\n -- The defaults are suitable for most people.\n\n -- Enable/disable animations\n animation = true,\n\n -- Enable/disable auto-hiding the tab bar when there is a single buffer\n auto_hide = false,\n\n -- Enable/disable current/total tabpages indicator (top right corner)\n tabpages = true,\n\n -- Enables/disable clickable tabs\n -- - left-click: go to buffer\n -- - middle-click: delete buffer\n clickable = true,\n\n -- Excludes buffers from the tabline\n exclude_ft = {'javascript'},\n exclude_name = {'package.json'},\n\n -- A buffer to this direction will be focused (if it exists) when closing the current buffer.\n -- Valid options are 'left' (the default), 'previous', and 'right'\n focus_on_close = 'left',\n\n -- Hide inactive buffers and file extensions. Other options are `alternate`, `current`, and `visible`.\n hide = {extensions = true, inactive = true},\n\n -- Disable highlighting alternate buffers\n highlight_alternate = false,\n\n -- Disable highlighting file icons in inactive buffers\n highlight_inactive_file_icons = false,\n\n -- Enable highlighting visible buffers\n highlight_visible = true,\n\n icons = {\n -- Configure the base icons on the bufferline.\n -- Valid options to display the buffer index and -number are `true`, 'superscript' and 'subscript'\n buffer_index = false,\n buffer_number = false,\n button = '',\n -- Enables / disables diagnostic symbols\n diagnostics = {\n [vim.diagnostic.severity.ERROR] = {enabled = true, icon = 'ff'},\n [vim.diagnostic.severity.WARN] = {enabled = false},\n [vim.diagnostic.severity.INFO] = {enabled = false},\n [vim.diagnostic.severity.HINT] = {enabled = true},\n },\n gitsigns = {\n added = {enabled = true, icon = '+'},\n changed = {enabled = true, icon = '~'},\n deleted = {enabled = true, icon = '-'},\n },\n filetype = {\n -- Sets the icon's highlight group.\n -- If false, will use nvim-web-devicons colors\n custom_colors = false,\n\n -- Requires `nvim-web-devicons` if `true`\n enabled = true,\n },\n separator = {left = '▎', right = ''},\n\n -- If true, add an additional separator at the end of the buffer list\n separator_at_end = true,\n\n -- Configure the icons on the bufferline when modified or pinned.\n -- Supports all the base icon options.\n modified = {button = '●'},\n pinned = {button = '', filename = true},\n\n -- Use a preconfigured buffer appearance— can be 'default', 'powerline', or 'slanted'\n preset = 'default',\n\n -- Configure the icons on the bufferline based on the visibility of a buffer.\n -- Supports all the base icon options, plus `modified` and `pinned`.\n alternate = {filetype = {enabled = false}},\n current = {buffer_index = true},\n inactive = {button = '×'},\n visible = {modified = {buffer_number = false}},\n },\n\n -- If true, new buffers will be inserted at the start/end of the list.\n -- Default is to insert after current buffer.\n insert_at_end = false,\n insert_at_start = false,\n\n -- Sets the maximum padding width with which to surround each tab\n maximum_padding = 1,\n\n -- Sets the minimum padding width with which to surround each tab\n minimum_padding = 1,\n\n -- Sets the maximum buffer name length.\n maximum_length = 30,\n\n -- Sets the minimum buffer name length.\n minimum_length = 0,\n\n -- If set, the letters for each buffer in buffer-pick mode will be\n -- assigned based on their name. Otherwise or in case all letters are\n -- already assigned, the behavior is to assign letters in order of\n -- usability (see order below)\n semantic_letters = true,\n\n -- Set the filetypes which barbar will offset itself for\n sidebar_filetypes = {\n -- Use the default values: {event = 'BufWinLeave', text = nil}\n NvimTree = true,\n -- Or, specify the text used for the offset:\n undotree = {text = 'undotree'},\n -- Or, specify the event which the sidebar executes when leaving:\n ['neo-tree'] = {event = 'BufWipeout'},\n -- Or, specify both\n Outline = {event = 'BufWinLeave', text = 'symbols-outline'},\n },\n\n -- New buffer letters are assigned in this order. This order is\n -- optimal for the qwerty keyboard layout but might need adjustment\n -- for other layouts.\n letters = 'asdfjkl;ghnmxcvbziowerutyqpASDFJKLGHNMXCVBZIOWERUTYQP',\n\n -- Sets the name of unnamed buffers. By default format is \"[Buffer X]\"\n -- where X is the buffer number. But only a static string is accepted here.\n no_name_title = nil,\n}\nHighlight groups are created in this way: Buffer<STATUS><PART>.
| <STATUS> | Meaning |\n|:------------|:--------------------------------------------------------|\n| Alternate | The :h alternate-file. |\n| Current | The current buffer. |\n| Inactive | :h hidden-buffers and :h inactive-buffers. |\n| Visible | :h active-buffers which are not alternate or current. |
| <PART> | Meaning |\n|:---------------|:-------------------------------------------------------------------------------------|\n| ADDED | Git status added. |\n| CHANGED | Git status changed. |\n| DELETED | Git status deleted. |\n| ERROR | Diagnostic errors. |\n| HINT | Diagnostic hints. |\n| Icon | The filetype icon (when icons.filetype == {custom_colors = true, enabled = true}). |\n| Index | The buffer's position in the tabline. |\n| INFO | Diagnostic info. |\n| Mod | When the buffer is modified. |\n| Number | The :h bufnr(). |\n| Sign | The separator between buffers. |\n| SignRight | The separator between buffers. |\n| Target | The letter in buffer-pick mode. |\n| WARN | Diagnostic warnings. |
BufferCurrentModYou can also use the doom-one.vim\ncolorscheme that defines those groups and is also very pleasant as you could see\nin the demos above.
\nbarbar.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.
Here is a mini.sessions config which can be used:
vim.opt.sessionoptions:append 'globals'\nrequire'mini.sessions'.setup {\n hooks = {\n pre = {\n write = function() vim.api.nvim_exec_autocmds('User', {pattern = 'SessionSavePre'}) end,\n },\n },\n}\nHere is a persistence.nvim config which can be used:
require'persistence'.setup {\n options = {--[[<other options>,]] 'globals'},\n pre_save = function() vim.api.nvim_exec_autocmds('User', {pattern = 'SessionSavePre'}) end,\n}\nYou can add this snippet to your config to take advantage of our session integration:
\nvim.opt.sessionoptions:append 'globals'\nvim.api.nvim_create_user_command(\n 'Mksession',\n function(attr)\n vim.api.nvim_exec_autocmds('User', {pattern = 'SessionSavePre'})\n\n -- Neovim 0.8+\n vim.cmd.mksession {bang = attr.bang, args = attr.fargs}\n\n -- Neovim 0.7\n vim.api.nvim_command('mksession ' .. (attr.bang and '!' or '') .. attr.args)\n end,\n {bang = true, complete = 'file', desc = 'Save barbar with :mksession', nargs = '?'}\n)\nBarbar doesn't show up because lightline changes the tabline setting. Add:
\nlet g:lightline={ 'enable': {'statusline': 1, 'tabline': 0} }\nnetrw 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).
You can use any other file explorer instead.
\nThe 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.
Barbar is called barbar because it's a bar, but it's also more than a bar:\na \"barbar\".
\nIt is pronounced like \"Jar Jar\" in \"Jar Jar Binks\", but with Bs.
\nNo, barbar has nothing to do with barbarians.
\n