plugins.bufferline.enable

Whether to enable bufferline.

Type: boolean

Default: false

Example: true

Declared by:

plugins.bufferline.package

Which package to use for the bufferline plugin.

Type: package

Default: <derivation vimplugin-bufferline.nvim-2024-04-22>

Declared by:

plugins.bufferline.alwaysShowBufferline

Whether to always show the bufferline.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.bufferCloseIcon

The close icon for each buffer.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.closeCommand

Command or function run when closing a buffer.

Plugin default: "bdelete! %d"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.closeIcon

The close icon.

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.colorIcons

Enable color icons.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.customFilter

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

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.bufferline.diagnostics

diagnostics

Plugin default: false

Type: null or boolean or one of “nvim_lsp”, “coc”

Default: null

Declared by:

plugins.bufferline.diagnosticsIndicator

Either null or a function that returns the diagnostics indicator.

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.bufferline.diagnosticsUpdateInInsert

Whether diagnostics should update in insert mode

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.enforceRegularTabs

Whether to enforce regular tabs.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.bufferline.getElementIcon

Lua function returning an element icon.

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

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.bufferline.leftMouseCommand

Command or function run when clicking on a buffer.

Plugin default: "buffer %d"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.leftTruncMarker

left trunc marker

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.maxNameLength

Max length of a buffer name.

Plugin default: 18

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

Default: null

Declared by:

plugins.bufferline.maxPrefixLength

Maximum prefix length

Plugin default: 15

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

Default: null

Declared by:

plugins.bufferline.middleMouseCommand

Command or function run when middle clicking on a buffer.

Plugin default: null

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.mode

mode

Plugin default: "buffers"

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

Default: null

Declared by:

plugins.bufferline.modifiedIcon

The icon indicating a buffer was modified.

Plugin default: "●"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.nameFormatter

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

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.bufferline.numbers

Customize the styling of numbers.

Either one of “none” “ordinal” “buffer_id” “both” or a lua function:

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

Plugin default: none

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

Default: null

Declared by:

plugins.bufferline.offsets

offsets

Plugin default: null

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

Default: null

Declared by:

plugins.bufferline.persistBufferSort

Whether to make the buffer sort persistent.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.rightMouseCommand

Command or function run when right clicking on a buffer.

Plugin default: "bdelete! %d"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.rightTruncMarker

right trunc marker

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.separatorStyle

Separator style

Plugin default: "thin"

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

Default: null

Declared by:

plugins.bufferline.showBufferCloseIcons

Show buffer close icons

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.showBufferIcons

Show buffer icons

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.showCloseIcon

Whether to show the close icon.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.showDuplicatePrefix

Whether to show the prefix of duplicated files.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.showTabIndicators

Whether to show the tab indicators.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.sortBy

sort by

Plugin default: "id"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.bufferline.tabSize

Size of the tabs

Plugin default: 18

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

Default: null

Declared by:

plugins.bufferline.themable

Whether or not bufferline highlights can be overridden externally

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.bufferline.truncateNames

Whether to truncate names.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by: