Skip to main content

Symbols Outline

info

You can enable the extra with the :LazyExtras command. Plugins marked as optional will only be configured if they are installed.

Alternatively, you can add it to your lazy.nvim imports
lua/config/lazy.lua
require("lazy").setup({
  spec = {
    { "LazyVim/LazyVim", import = "lazyvim.plugins" },
    { import = "lazyvim.plugins.extras.editor.symbols-outline" },
    { import = "plugins" },
  },
})

Below you can find a list of included plugins and their default settings.

caution

You don't need to copy the default settings to your config. They are only shown here for reference.

symbols-outline.nvim​

opts = function()
  local Config = require("lazyvim.config")
  local defaults = require("symbols-outline.config").defaults
  local opts = {
    symbols = {},
    symbol_blacklist = {},
  }
  local filter = Config.kind_filter

  if type(filter) == "table" then
    filter = filter.default
    if type(filter) == "table" then
      for kind, symbol in pairs(defaults.symbols) do
        opts.symbols[kind] = {
          icon = Config.icons.kinds[kind] or symbol.icon,
          hl = symbol.hl,
        }
        if not vim.tbl_contains(filter, kind) then
          table.insert(opts.symbol_blacklist, kind)
        end
      end
    end
  end
  return opts
end

edgy.nvim (optional)​

edgy integration

opts = function(_, opts)
  local edgy_idx = Util.plugin.extra_idx("ui.edgy")
  local symbols_idx = Util.plugin.extra_idx("editor.symbols-outline")

  if edgy_idx and edgy_idx > symbols_idx then
    Util.warn(
      "The `edgy.nvim` extra must be **imported** before the `symbols-outline.nvim` extra to work properly.",
      {
        title = "LazyVim",
      }
    )
  end

  opts.right = opts.right or {}
  table.insert(opts.right, {
    title = "Symbols Outline",
    ft = "Outline",
    pinned = true,
    open = "SymbolsOutline",
  })
end