Library of 45+ independent Lua modules improving Neovim experience with minimal effort nvim-mini.org/mini.nvim
mini.nvim readmes mini-tabline.md
5.7 kB · 156 lines
Markdown
at main

mini.tabline

Minimal and fast tabline showing listed buffers #

See more details in Features and Documentation.


Note

This was previously hosted at a personal echasnovski GitHub account. It was transferred to a dedicated organization to improve long term project stability. See more details here.

⦿ This is a part of mini.nvim library. Please use this link if you want to mention this module.

⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.

⦿ See whole library documentation to learn about general design principles, disable/configuration recipes, and more.

⦿ See MiniMax for a full config example that uses this module.


If you want to help this project grow but don't know where to start, check out contributing guides of 'mini.nvim' or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.

Demo #

https://user-images.githubusercontent.com/24854248/173045373-f5bdea82-fe3e-4488-8c9a-ebba062a373c.mp4

Features #

  • Buffers are listed in the order of their identifier.
  • Different highlight groups for "states" of buffer affecting 'buffer tabs'.
  • Buffer names are made unique by extending paths to files or appending unique identifier to buffers without name.
  • Current buffer is displayed "optimally centered" (in center of screen while maximizing the total number of buffers shown) when there are many buffers open.
  • 'Buffer tabs' are clickable if Neovim allows it.
  • Extra information section in case of multiple Neovim tabpages.
  • Truncation symbols which show if there are tabs to the left and/or right. Exact characters are taken from 'listchars' option (precedes and extends fields) and are shown only if 'list' option is enabled.

Dependencies #

For full experience needs (still works without any of suggestions):

Installation #

This plugin can be installed as part of 'mini.nvim' library (recommended) or as a standalone Git repository.

There are two branches to install from:

  • main (default, recommended) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled).
  • stable will be updated only upon releases with code tested during public beta-testing phase in main branch.

Here are code snippets for some common installation methods (use only one):

(Recommended) With vim.pack (on Neovim 0.12 and newer)

Full library

Follow 'mini.nvim' installation.

Standalone plugin

Main branch:

vim.pack.add({ 'https://github.com/nvim-mini/mini.tabline' })

Stable branch:

vim.pack.add({
  { src = 'https://github.com/nvim-mini/mini.tabline', version = 'stable' },
})
With mini.deps (before Neovim 0.12)

Full library

Follow recommended 'mini.deps' installation.

Standalone plugin:

Main branch:

add('nvim-mini/mini.tabline')

Stable branch:

add({ source = 'nvim-mini/mini.tabline', checkout = 'stable' })
With folke/lazy.nvim

Full library

Follow 'mini.nvim' installation.

Standalone plugin

Main branch:

{ 'nvim-mini/mini.tabline', version = false },

Stable branch:

{ 'nvim-mini/mini.tabline', version = '*' },

Important: don't forget to call require('mini.tabline').setup() to enable its functionality.

Note: if you are on Windows, there might be problems with too long file paths (like error: unable to create file <some file name>: Filename too long). Try doing one of the following:

  • Enable corresponding git global config value: git config --system core.longpaths true. Then try to reinstall.
  • Install plugin in other place with shorter path.

Default config #

-- No need to copy this inside `setup()`. Will be used automatically.
{
  -- Whether to show file icons (requires 'mini.icons')
  show_icons = true,

  -- Function which formats the tab label
  -- By default surrounds with space and possibly prepends with icon
  format = nil,

  -- Where to show tabpage section in case of multiple vim tabpages.
  -- One of 'left', 'right', 'none'.
  tabpage_section = 'left',
}

Similar plugins #