nixvim docs

plugins.barbecue.settings

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

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by:

• <nixvim/plugins/by-name/barbecue>

plugins.barbecue.settings.attach_navic

Whether to attach navic to language servers automatically.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

• <nixvim/plugins/by-name/barbecue>

plugins.barbecue.settings.context_follow_icon_color

Whether context text should follow its icon’s color.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

• <nixvim/plugins/by-name/barbecue>

plugins.barbecue.settings.create_autocmd

Whether to create winbar updater autocmd.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

• <nixvim/plugins/by-name/barbecue>

plugins.barbecue.settings.custom_section

Get custom section contents. NOTE: This function shouldn’t do any expensive actions as it is run on each render.

Type: null or lua function string

Default: null

Plugin default:

''
  function()
    return " "
  end
''

Declared by:

• <nixvim/plugins/by-name/barbecue>

plugins.barbecue.settings.exclude_filetypes

Filetypes not to enable winbar in.

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

Default: null

Plugin default:

[
  "netrw"
  "toggleterm"
]

Declared by:

• <nixvim/plugins/by-name/barbecue>

plugins.barbecue.settings.include_buftypes

Buftypes to enable winbar in.

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

Default: null

Plugin default:

[
  ""
]

Declared by:

• <nixvim/plugins/by-name/barbecue>

plugins.barbecue.settings.lead_custom_section

Get leading custom section contents. NOTE: This function shouldn’t do any expensive actions as it is run on each render.

Type: null or lua function string

Default: null

Plugin default:

''
  function()
    return " "
  end
''

Declared by:

• <nixvim/plugins/by-name/barbecue>

plugins.barbecue.settings.modified

Get modified status of file. NOTE: This can be used to get file modified status from SCM (e.g. git)

Type: null or lua function string

Default: null

Plugin default:

''
  function(bufnr)
  	return vim.bo[bufnr].modified
  end
''

Declared by:

• <nixvim/plugins/by-name/barbecue>

plugins.barbecue.settings.show_basename

Whether to display file name.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

• <nixvim/plugins/by-name/barbecue>

plugins.barbecue.settings.show_dirname

Whether to display path to file.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

• <nixvim/plugins/by-name/barbecue>

plugins.barbecue.settings.show_modified

Whether to replace file icon with the modified symbol when buffer is modified.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

• <nixvim/plugins/by-name/barbecue>

plugins.barbecue.settings.show_navic

Whether to show/use navic in the winbar.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

• <nixvim/plugins/by-name/barbecue>

plugins.barbecue.settings.theme

Theme to be used for generating highlight groups dynamically.

Type: null or string or raw lua code

Default: null

Plugin default: "auto"

Declared by:

• <nixvim/plugins/by-name/barbecue>