Skip to content

Latest commit

 

History

History
161 lines (130 loc) · 6.12 KB

mini-tabline.md

File metadata and controls

161 lines (130 loc) · 6.12 KB
Raw

GitHub license

Minimal and fast tabline showing listed buffers

For full experience needs nvim-tree/nvim-web-devicons plugin (but works without it).

See more details in Features and help file.

⦿ 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 the repository page to learn about common design principles and configuration recipes.

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

demo-tabline.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.
  • Allow showing extra information section in case of multiple Neovim tabpages.

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):

With folke/lazy.nvim
Github repo Branch Code snippet
'mini.nvim' library Main { 'echasnovski/mini.nvim', version = false },
Stable { 'echasnovski/mini.nvim', version = '*' },
Standalone plugin Main { 'echasnovski/mini.tabline', version = false },
Stable { 'echasnovski/mini.tabline', version = '*' },
With wbthomason/packer.nvim
Github repo Branch Code snippet
'mini.nvim' library Main use 'echasnovski/mini.nvim'
Stable use { 'echasnovski/mini.nvim', branch = 'stable' }
Standalone plugin Main use 'echasnovski/mini.tabline'
Stable use { 'echasnovski/mini.tabline', branch = 'stable' }
With junegunn/vim-plug
Github repo Branch Code snippet
'mini.nvim' library Main Plug 'echasnovski/mini.nvim'
Stable Plug 'echasnovski/mini.nvim', { 'branch': 'stable' }
Standalone plugin Main Plug 'echasnovski/mini.tabline'
Stable Plug 'echasnovski/mini.tabline', { 'branch': 'stable' }

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 'nvim-tree/nvim-web-devicons')
  show_icons = true,

  -- Whether to set Vim's settings for tabline (make it always shown and
  -- allow hidden buffers)
  set_vim_settings = true,

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

Similar plugins