This is a fork of the original symbols-outline.nvim which merges some selected PRs from the original repo, plus some other improvements due to personal preferences.

It does not attempt to be an up-to-date successor of the original repo, nor does it attempt to ensure everyone's use-cases are satisfied by providing an overall better experience. It is merely a fork which I maintain for my personal use-cases which incorporates some selected PRs.

Maintenance status

This fork is NOT guaranteed to be completely bug-free, nor as stable as the original. However, since I use this plugin myself, it is guaranteed that selected issues that I encounter myself would be fixed (to the best of my ability).

I do not merge PRs from the original repo that I don't personally need.

DO use this fork if:
- You want to use features available in this fork, which are not included upstream (listed below)
- You MIGHT want some up-to-date fixes to problems (that I also face) but is OK with some things not being looked after well (things I don't personally use)
Do NOT use this fork if:
- You want a stable plugin
- You don't need the extra features in this fork

Features

Below is a list of features I've included in this fork which, at the time of writing, has not been included upstream (in the original repo). I try my best to keep this list up to date.

Features:

Feat: Toggling folds (and added default keymaps for it) (simrat39/symbols-outline.nvim#194)
Feat: Control focus between outline and code window.
- New commands: SymbolsOutlineFocus,FocusOutline,FocusCode (see commands)
- Fixed issues:
Feat: when auto_close=true only auto close if goto_location is used (where focus changed), and not for focus_location (simrat39/symbols-outline.nvim#119)
Feat: Cursorline option for the outline window

Fixes:

Fix symbol preview (simrat39/symbols-outline.nvim#176)
Fix SymbolsOutlineClose crashing when already closed: simrat39/symbols-outline.nvim#163
Support Nerd fonts v3.0: simrat39/symbols-outline.nvim#225
Fix newlines in symbols crash: simrat39/symbols-outline.nvim#204 (simrat39/symbols-outline.nvim#184)
Fix code_actions: simrat39/symbols-outline.nvim#168 (simrat39/symbols-outline.nvim#123)
Fix fold all operation too slow: simrat39/symbols-outline.nvim#223 (simrat39/symbols-outline.nvim#224)

PRs

Open handler checks if view is not already open (#235 by eyalz800)
auto_jump config param (#229 by stickperson)
✅ Update nerd fonts to 3.0 (#225 by anstadnik)
✅ fix(folding): optimize fold/unfold all (#223 by wjdwndud0114)
✅ Support markdown setext-style headers (#222 by msr1k)
✅ fix(icons): replace obsolete icons (#219 by loichyan) Superseded by #225
✅ Support ccls symbols (#218 by rqdmap)
✅ fix: replace newlines with spaces in writer (#204 by tbung)
✅ Make close_outline idempotent (#200 by showermat) Superseded by #163
Distinguish between public and private function display in Elixir (#187 by scottming)
✅ Fix some options (#180 by cljoly)
fix: Invalid buffer id error (#177 by snowair)
✅ fix(code_actions): use the builtin code_action (#168 by zjp-CN)
✅ fix: plugin crashes when SymbolOutlineClose used (#163 by beauwilliams)
feat: Add window_bg_highlight to config (#137 by Zane-)
Added preview width and relative size (#130 by Freyskeyd)
Improve preview, hover windows configurability and looks (#128 by toppair)
✅ Do not close outline when focus_location occurs (#119 by M1Sports20)
feat: instant_preview (#116 by axieax)
check if code_win is nill (#110 by i3Cheese)
Floating window (Draft) (#101 by druskus20)

TODO

KEY:

- [ ] : Planned
- [/] : WIP
-     : Idea

Items will be moved to above list when complete.

Folds
- Org-like shift+tab behavior: Open folds level-by-level
- Optionally not opening all child nodes when opening parent node
- Fold siblings and siblings of parent on startup
Navigation
- Go to parent
- Cycle siblings
simrat39/symbols-outline.nvim#75: Handling of the outline window when attached buffer is closed.

Maybe it should continue working, so that pressing enter can open a split to the correct location, and pressing q can properly close the buffer.

nvim-navic
nvim-navbuddy
dropdown.nvim
treesitter (inspect/edit)

symbols-outline.nvim

A tree like view for symbols in Neovim using the Language Server Protocol. Supports all your favourite languages.

Prerequisites

neovim 0.7+
Properly configured Neovim LSP client

Installation

Use hedyhli/symbols-outline.nvim if you wish to use this fork.

Packer:

use 'simrat39/symbols-outline.nvim'

Lazy:

{
  "simrat39/symbols-outline.nvim",
  config = function()
    -- Example mapping to toggle outline
    vim.keymap.set("n", "<leader>tt", "<cmd>SymbolsOutline<CR>",
      { desc = "SymbolsOutline" })

    require("symbols-outline").setup {
      -- Your setup opts here (leave empty to use defaults)
    }
  end,
},

Lazy with lazy-loading:

{
  "simrat39/symbols-outline.nvim",
  cmd = { "SymbolsOutline", "SymbolsOutlineOpen" },
  keys = {
    -- Example mapping to toggle outline
    { "<leader>tt", "<cmd>SymbolsOutline<CR>", desc = "Toggle outline window" },
  },
  opts = {
    -- Your setup opts here
  },
},

This allows Lazy.nvim to lazy load the plugin on commands SymbolsOutline, SymbolsOutlineOpen, and your keybindings.

Setup

Call the setup function with your configuration options.

Note that a call to .setup() is required for this plugin to work (simrat39/symbols-outline.nvim#213).

require("symbols-outline").setup({})

Configuration

Pass a table to the setup call above with your configuration options.

local opts = {
  highlight_hovered_item = true,
  show_guides = true,
  auto_preview = false,
  position = 'right',
  relative_width = true,
  width = 25,
  -- Behaviour changed in this fork:
  -- Auto close the outline window if goto_location is triggered and not for
  -- focus_location
  auto_close = false,
  show_numbers = false,
  show_relative_numbers = false,
  show_cursorline = true,
  show_symbol_details = true,
  -- Highlight group for the preview background
  preview_bg_highlight = 'Pmenu',
  autofold_depth = nil,
  auto_unfold_hover = true,
  fold_markers = { '', '' },
  wrap = false,
  -- Only in this fork:
  -- Whether to focus on the outline window when it is opened.
  -- Set to false to remain focus on your previous buffer when opening
  -- symbols-outline.
  focus_on_open = true,
  keymaps = { -- These keymaps can be a string or a table for multiple keys
    close = {"<Esc>", "q"},
    -- Jump to symbol under cursor
    goto_location = "<Cr>",
    -- Jump to symbol under cursor but keep focus on outline window
    focus_location = "o",
    hover_symbol = "<C-space>",
    -- Preview symbol under cursor
    toggle_preview = "K",
    rename_symbol = "r",
    code_actions = "a",
    -- These fold actions are collapsing tree items, not code folding
    fold = "h",
    fold_toggle = '<tab>',       -- Only in this fork
    fold_toggle_all = '<S-tab>', -- Only in this fork
    unfold = "l",
    fold_all = "W",
    unfold_all = "E",
    fold_reset = "R",
  },
  lsp_blacklist = {},
  symbol_blacklist = {},
  symbols = {
    -- Changed in this fork
    File = { icon = "󰈔", hl = "@text.uri" },
    Module = { icon = "󰆧", hl = "@namespace" },
    Namespace = { icon = "󰅪", hl = "@namespace" },
    Package = { icon = "󰏗", hl = "@namespace" },
    Class = { icon = "𝓒", hl = "@type" },
    Method = { icon = "ƒ", hl = "@method" },
    Property = { icon = "", hl = "@method" },
    Field = { icon = "󰆨", hl = "@field" },
    Constructor = { icon = "", hl = "@constructor" },
    Enum = { icon = "ℰ", hl = "@type" },
    Interface = { icon = "󰜰", hl = "@type" },
    Function = { icon = "", hl = "@function" },
    Variable = { icon = "", hl = "@constant" },
    Constant = { icon = "", hl = "@constant" },
    String = { icon = "𝓐", hl = "@string" },
    Number = { icon = "#", hl = "@number" },
    Boolean = { icon = "⊨", hl = "@boolean" },
    Array = { icon = "󰅪", hl = "@constant" },
    Object = { icon = "⦿", hl = "@type" },
    Key = { icon = "🔐", hl = "@type" },
    Null = { icon = "NULL", hl = "@type" },
    EnumMember = { icon = "", hl = "@field" },
    Struct = { icon = "𝓢", hl = "@type" },
    Event = { icon = "🗲", hl = "@type" },
    Operator = { icon = "+", hl = "@operator" },
    TypeParameter = { icon = "𝙏", hl = "@parameter" },
    Component = { icon = "󰅴", hl = "@function" },
    Fragment = { icon = "󰅴", hl = "@constant" },
    -- ccls
    TypeAlias =  { icon = ' ', hl = '@type' },
    Parameter = { icon = ' ', hl = '@parameter' },
    StaticMethod = { icon = ' ', hl = '@function' },
    Macro = { icon = ' ', hl = '@macro' },
  },
}

Property	Description	Type	Default
highlight_hovered_item	Whether to highlight the currently hovered symbol (high cpu usage)	boolean	true
show_guides	Whether to show outline guides	boolean	true
position	Where to open the split window	'right' or 'left'	'right'
relative_width	Whether width of window is set relative to existing windows	boolean	true
width	Width of window (as a % or columns based on `relative_width`)	int	25
auto_close	Whether to automatically close the window after `goto_location`	boolean	false
auto_preview	Show a preview of the code on hover	boolean	false
show_numbers	Shows numbers with the outline	boolean	false
show_relative_numbers	Shows relative numbers with the outline	boolean	false
show_symbol_details	Shows extra details with the symbols (lsp dependent)	boolean	true
preview_bg_highlight	Background color of the preview window	string	Pmenu
winblend	Pseudo-transparency of the preview window	int	0
keymaps	Which keys do what	table (dictionary)	here
symbols	Icon and highlight config for symbol icons	table (dictionary)	scroll up
lsp_blacklist	Which lsp clients to ignore	table (array)	{}
symbol_blacklist	Which symbols to ignore (possible values)	table (array)	{}
autofold_depth	Depth past which nodes will be folded by default	int	nil
auto_unfold_hover	Automatically unfold hovered symbol	boolean	true
fold_markers	Markers to denote foldable symbol's status	table (array)	{ '', '' }
wrap	Whether to wrap long lines, or let them flow off the window	boolean	false
focus_on_open	Whether to focus cursor on the outline window when opening	boolean	true

Commands

Command	Description
`:SymbolsOutline`	Toggle symbols outline
`:SymbolsOutlineOpen`	Open symbols outline
`:SymbolsOutlineClose`	Close symbols outline
`:SymbolsOutlineFocus`	Toggle focus on symbols outline
`:SymbolsOutlineFocusOutline`	Focus on symbols outline
`:SymbolsOutlineFocusCode`	Focus on source window

Lua API

require'symbols-outline'

setup(opts)
toggle_outline()
open_outline()
close_outline()
focus_toggle()
focus_outline()
focus_code()

Default keymaps

Key	Action
Escape	Close outline
Enter	Go to symbol location in code
o	Go to symbol location in code without losing focus
Ctrl+Space	Hover current symbol
K	Toggles the current symbol preview
r	Rename symbol
a	Code actions
h	fold symbol
tab	toggle fold under cursor
shift+tab	toggle all folds
l	Unfold symbol
W	Fold all symbols
E	Unfold all symbols
R	Reset all folding
?	Show help message

Highlights

Highlight	Purpose
FocusedSymbol	Highlight of the focused symbol
Pmenu	Highlight of the preview popup windows
SymbolsOutlineConnector	Highlight of the table connectors
Comment	Highlight of the info virtual text

README.md Unescape Escape

⚠️ NOTE: THIS IS A FORK