plugins.bufferline.settings.options.always_show_bufferline

Whether to always show the bufferline.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.bufferline.settings.options.auto_toggle_bufferline

Whether to automatically toggle bufferline.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.bufferline.settings.options.buffer_close_icon

The close icon for each buffer.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.bufferline.settings.options.close_command

Command or function run when closing a buffer.

Type: null or string or raw lua code

Default: null

Plugin default: "bdelete! %d"

Declared by:

plugins.bufferline.settings.options.close_icon

The close icon.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.bufferline.settings.options.color_icons

Whether or not to add the filetype icon highlights.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.bufferline.settings.options.custom_filter

fun(buf: number, bufnums: number[]): boolean

NOTE: this will be called a lot so don’t do any heavy processing here.

Type: null or lua function string

Default: null

Plugin default: null

Declared by:

plugins.bufferline.settings.options.diagnostics

Diagnostics provider.

Set to false to disable.

Type: null or one of false, “nvim_lsp”, “coc” or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.bufferline.settings.options.diagnostics_indicator

Either null or a function that returns the diagnostics indicator.

Type: null or lua function string

Default: null

Plugin default: null

Declared by:

plugins.bufferline.settings.options.diagnostics_update_on_event

Use nvim’s diagnostic handler.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.bufferline.settings.options.duplicates_across_groups

Whether to consider duplicate paths in different groups as duplicates.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.bufferline.settings.options.enforce_regular_tabs

Whether to enforce regular tabs.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.bufferline.settings.options.get_element_icon

Lua function returning an element icon.

fun(opts: IconFetcherOpts): string?, string?

Type: null or lua function string

Default: null

Plugin default: null

Declared by:

plugins.bufferline.settings.options.left_mouse_command

Command or function run when clicking on a buffer.

Type: null or string or raw lua code

Default: null

Plugin default: "buffer %d"

Declared by:

plugins.bufferline.settings.options.left_trunc_marker

Left truncation marker.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.bufferline.settings.options.max_name_length

Max length of a buffer name.

Type: null or signed integer or floating point number or raw lua code

Default: null

Plugin default: 18

Declared by:

plugins.bufferline.settings.options.max_prefix_length

Maximum prefix length used when a buffer is de-duplicated.

Type: null or signed integer or floating point number or raw lua code

Default: null

Plugin default: 15

Declared by:

plugins.bufferline.settings.options.middle_mouse_command

Command or function run when middle clicking on a buffer.

Type: null or string or raw lua code

Default: null

Plugin default: null

Declared by:

plugins.bufferline.settings.options.mode

Mode - set to tabs to only show tabpages instead.

Type: null or one of “buffers”, “tabs” or raw lua code

Default: null

Plugin default: "buffers"

Declared by:

plugins.bufferline.settings.options.modified_icon

The icon indicating a buffer was modified.

Type: null or string or raw lua code

Default: null

Plugin default: "●"

Declared by:

plugins.bufferline.settings.options.move_wraps_at_ends

Whether or not the move command “wraps” at the first or last position.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.bufferline.settings.options.name_formatter

A lua function that can be used to modify the buffer’s label. The argument ‘buf’ containing a name, path and bufnr is supplied.

Type: null or lua function string

Default: null

Plugin default: null

Declared by:

plugins.bufferline.settings.options.numbers

Customize the styling of numbers.

Can also be a lua function:

function({ ordinal, id, lower, raise }): string

Type: null or one of “none”, “ordinal”, “buffer_id”, “both” or raw lua code

Default: null

Plugin default: "none"

Declared by:

plugins.bufferline.settings.options.offsets

offsets

Type: null or (list of (attribute set))

Default: null

Plugin default: null

Declared by:

plugins.bufferline.settings.options.persist_buffer_sort

Whether to make the buffer sort persistent.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.bufferline.settings.options.right_mouse_command

Command or function run when right clicking on a buffer.

Type: null or string or raw lua code

Default: null

Plugin default: "bdelete! %d"

Declared by:

plugins.bufferline.settings.options.right_trunc_marker

Right truncation marker.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.bufferline.settings.options.separator_style

Separator style.

Type: null or one of “slant”, “padded_slant”, “slope”, “padded_slope”, “thick”, “thin” or list of 2 string or raw lua code

Default: null

Plugin default: "thin"

Declared by:

plugins.bufferline.settings.options.show_buffer_close_icons

Show buffer close icons.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.bufferline.settings.options.show_buffer_icons

Show buffer icons.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.bufferline.settings.options.show_close_icon

Whether to show the close icon.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.bufferline.settings.options.show_duplicate_prefix

Whether to show the prefix of duplicated files.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.bufferline.settings.options.show_tab_indicators

Whether to show the tab indicators.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.bufferline.settings.options.sort_by

How to sort the buffers.

Also accepts a function with a signature function(buffer_a, buffer_b) allowing you to compare with custom logic.

Type: null or one of “insert_after_current”, “insert_at_end”, “id”, “extension”, “relative_directory”, “directory”, “tabs” or raw lua code

Default: null

Plugin default: "id"

Declared by:

plugins.bufferline.settings.options.tab_size

Size of the tabs.

Type: null or signed integer or floating point number or raw lua code

Default: null

Plugin default: 18

Declared by:

plugins.bufferline.settings.options.themable

Whether or not bufferline highlights can be overridden externally.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.bufferline.settings.options.truncate_names

Whether to truncate names.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by: