https://user-images.githubusercontent.com/37078297/215765075-bc89050e-ad74-481a-9344-06ca997bf290.mp4

✨ Features

• 🖱️ Jump to any context by just clicking on it.

• 🌲 Have a deeply nested file-tree/context? It's gonna get rid of the less useful parts smartly.

• 📂 Easily tell where your file is located at by looking at your winbar.

• 📜 Put whatever your heart desires in the custom section.

📬 Dependencies

• NVIM v0.8+: Winbar support.

• nvim-navic: LSP textDocument/documentSymbol provider.

• nvim-web-devicons: File icon provider. (optional)

📦 Installation

NOTE: Make sure barbecue loads after your colorscheme.

• lazy.nvim

  {
  "utilyre/barbecue.nvim",
  name = "barbecue",
  version = "*",
  dependencies = {
    "SmiteshP/nvim-navic",
    "nvim-tree/nvim-web-devicons", -- optional dependency
  },
  opts = {
    -- configurations go here
  },
  }

• packer.nvim

  use({
  "utilyre/barbecue.nvim",
  tag = "*",
  requires = {
    "SmiteshP/nvim-navic",
    "nvim-tree/nvim-web-devicons", -- optional dependency
  },
  after = "nvim-web-devicons", -- keep this if you're using NvChad
  config = function()
    require("barbecue").setup()
  end,
  })

🚀 Usage

Barbecue will work right after installation, but there are several things you should be aware of.

Command

Run :Barbecue and you'll be prompted to select a subcommand, choose one and press <enter> to execute.

You can also run :Barbecue [sub] where [sub] is one of the subcommands you've seen in the select menu of raw :Barbecue.

API

• Toggle barbecue [source]

  -- hide barbecue globally
  require("barbecue.ui").toggle(false)
  
  -- show barbecue globally
  require("barbecue.ui").toggle(true)
  
  -- toggle barbecue globally
  require("barbecue.ui").toggle()

• Update barbecue (e.g. in an autocmd) [source]

  -- update the current window's winbar
  require("barbecue.ui").update()
  
  -- update the given window's winbar
  require("barbecue.ui").update(winnr)

• Navigate to entry [source]

  -- navigate to the second entry
  require("barbecue.ui").navigate(2)
  
  -- navigate to the last entry
  require("barbecue.ui").navigate(-1)
  
  -- just like before but on the given window
  require("barbecue.ui").navigate(index, winnr)

🍴 Recipes

• Gain better performance when moving the cursor around

  -- triggers CursorHold event faster
  vim.opt.updatetime = 200
  
  require("barbecue").setup({
  create_autocmd = false, -- prevent barbecue from updating itself automatically
  })
  
  vim.api.nvim_create_autocmd({
  "WinScrolled", -- or WinResized on NVIM-v0.9 and higher
  "BufWinEnter",
  "CursorHold",
  "InsertLeave",
  
  -- include this if you have set `show_modified` to `true`
  "BufModifiedSet",
  }, {
  group = vim.api.nvim_create_augroup("barbecue.updater", {}),
  callback = function()
    require("barbecue.ui").update()
  end,
  })

• Customize theme

  You can pass a theme table to the setup function and override the default theme. This theme table links each highlight to its value (value is the same type as val parameter in :help nvim_set_hl).

  require("barbecue").setup({
  theme = {
    -- this highlight is used to override other highlights
    -- you can take advantage of its `bg` and set a background throughout your winbar
    -- (e.g. basename will look like this: { fg = "#c0caf5", bold = true })
    normal = { fg = "#c0caf5" },
  
    -- these highlights correspond to symbols table from config
    ellipsis = { fg = "#737aa2" },
    separator = { fg = "#737aa2" },
    modified = { fg = "#737aa2" },
  
    -- these highlights represent the _text_ of three main parts of barbecue
    dirname = { fg = "#737aa2" },
    basename = { bold = true },
    context = {},
  
    -- these highlights are used for context/navic icons
    context_file = { fg = "#ac8fe4" },
    context_module = { fg = "#ac8fe4" },
    context_namespace = { fg = "#ac8fe4" },
    context_package = { fg = "#ac8fe4" },
    context_class = { fg = "#ac8fe4" },
    context_method = { fg = "#ac8fe4" },
    context_property = { fg = "#ac8fe4" },
    context_field = { fg = "#ac8fe4" },
    context_constructor = { fg = "#ac8fe4" },
    context_enum = { fg = "#ac8fe4" },
    context_interface = { fg = "#ac8fe4" },
    context_function = { fg = "#ac8fe4" },
    context_variable = { fg = "#ac8fe4" },
    context_constant = { fg = "#ac8fe4" },
    context_string = { fg = "#ac8fe4" },
    context_number = { fg = "#ac8fe4" },
    context_boolean = { fg = "#ac8fe4" },
    context_array = { fg = "#ac8fe4" },
    context_object = { fg = "#ac8fe4" },
    context_key = { fg = "#ac8fe4" },
    context_null = { fg = "#ac8fe4" },
    context_enum_member = { fg = "#ac8fe4" },
    context_struct = { fg = "#ac8fe4" },
    context_event = { fg = "#ac8fe4" },
    context_operator = { fg = "#ac8fe4" },
    context_type_parameter = { fg = "#ac8fe4" },
  },
  })

• Get nvim-navic working with multiple tabs (#35)

  require("barbecue").setup({
  attach_navic = false, -- prevent barbecue from automatically attaching nvim-navic
  })
  
  require("lspconfig")[server].setup({
  -- ...
  
  on_attach = function(client, bufnr)
    -- ...
  
    if client.server_capabilities["documentSymbolProvider"] then
      require("nvim-navic").attach(client, bufnr)
    end
  
    -- ...
  end,
  
  -- ...
  })

🚠 Configuration

👥 Contribution

See CONTRIBUTING.md.