plugins.barbar.settings

Options provided to the require('barbar').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  animation = false;
  exclude_ft = [
    "oil"
    "qf"
    "fugitive"
  ];
  exclude_name = [
    "UnicodeTable.txt"
  ];
  highlight_alternate = true;
  icons = {
    button = false;
    separator_at_end = false;
  };
}

Declared by:

plugins.barbar.settings.animation

Enable/disable animations.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.barbar.settings.auto_hide

Automatically hide the ‘tabline’ when there are this many buffers left. Set to any value less than 0 to disable.

For example: auto_hide = 0 hides the ‘tabline’ when there would be zero buffers shown, auto_hide = 1 hides the ‘tabline’ when there would only be one, etc.

Type: null or signed integer or value false (singular enum) or raw lua code

Default: null

Plugin default: -1

Declared by:

plugins.barbar.settings.clickable

If set, you can left-click on a tab to switch to that buffer, and middle-click to delete it.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.barbar.settings.exclude_ft

Excludes filetypes from appearing in the tabs.

Type: null or (list of (string or raw lua code))

Default: null

Plugin default: [ ]

Declared by:

plugins.barbar.settings.exclude_name

Excludes buffers matching name from appearing in the tabs.

Type: null or (list of (string or raw lua code))

Default: null

Plugin default: [ ]

Declared by:

plugins.barbar.settings.focus_on_close

The algorithm to use for getting the next buffer after closing the current one:

  • 'left': focus the buffer to the left of the current buffer.
  • 'previous': focus the previous buffer.
  • 'right': focus the buffer to the right of the current buffer.

Type: null or one of “left”, “previous”, “right” or raw lua code

Default: null

Plugin default: "left"

Declared by:

plugins.barbar.settings.highlight_alternate

Enables highlighting of alternate buffers.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.barbar.settings.highlight_inactive_file_icons

Enables highlighting the file icons of inactive buffers.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.barbar.settings.highlight_visible

Enables highlighting of visible buffers.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.barbar.settings.insert_at_end

If true, new buffers appear at the end of the list. Default is to open after the current buffer.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.barbar.settings.insert_at_start

If true, new buffers appear at the start of the list. Default is to open after the current buffer.

Has priority over insert_at_end.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.barbar.settings.letters

New buffer letters are assigned in this order. This order is optimal for the QWERTY keyboard layout but might need adjustment for other layouts.

Type: null or string or raw lua code

Default: null

Plugin default: "asdfjkl;ghnmxcvbziowerutyqpASDFJKLGHNMXCVBZIOWERUTYQP"

Declared by:

plugins.barbar.settings.maximum_length

Sets the maximum buffer name length.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 30

Declared by:

plugins.barbar.settings.maximum_padding

Sets the maximum padding width with which to surround each tab.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 4

Declared by:

plugins.barbar.settings.minimum_length

Sets the minimum buffer name length.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 0

Declared by:

plugins.barbar.settings.minimum_padding

Sets the minimum padding width with which to surround each tab.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 1

Declared by:

plugins.barbar.settings.no_name_title

Sets the name of unnamed buffers.

By default format is '[Buffer X]' where X is the buffer number. However, only a static string is accepted here.

Type: null or string or raw lua code

Default: null

Plugin default: null

Declared by:

plugins.barbar.settings.semantic_letters

If true, 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 the order of provided to letters.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.barbar.settings.tabpages

Enable/disable current/total tabpages indicator (top right corner).

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by: