LazyVim.LazyVim/lua/lazyvim/plugins/extras/editor/navic.lua

38 lines
956 B
Lua
Raw Permalink Normal View History

2023-10-11 22:36:45 +02:00
return {
-- lsp symbol navigation for lualine. This shows where
-- in the code structure you are - within functions, classes,
-- etc - in the statusline.
{
"SmiteshP/nvim-navic",
lazy = true,
init = function()
vim.g.navic_silence = true
LazyVim.lsp.on_attach(function(client, buffer)
2023-10-11 22:36:45 +02:00
if client.supports_method("textDocument/documentSymbol") then
require("nvim-navic").attach(client, buffer)
end
end)
end,
opts = function()
return {
separator = " ",
highlight = true,
depth_limit = 5,
2024-06-16 15:35:38 +02:00
icons = LazyVim.config.icons.kinds,
2023-10-11 22:36:45 +02:00
lazy_update_context = true,
}
end,
},
-- lualine integration
{
"nvim-lualine/lualine.nvim",
optional = true,
opts = function(_, opts)
if not vim.g.trouble_lualine then
fix(navic): use the same background color as lualine section_c (#4231) ## Description Prior to this, when using the navic Extra, the symbol breadcrumbs shown in lualine section_c had a background color different from the background of lualine_c, causing it to standout and not blend in with some colorschemes. There were ways around this problem, but hose involved overriding a lot of highlights. See https://github.com/LazyVim/LazyVim/issues/328 This change uses the new (as of April 2023) lualine component built in to SmiteshP/nvim-navic, which has a `color_correction` option to fix the problem described above. This built-in component replaces the manual method of calling `require("nvim-navic").is_available()` and `require("nvim-navic").get_location()`. * https://github.com/SmiteshP/nvim-navic/commit/711e9f117a0936c9d4420a135d658d2ca53a9e99 * https://github.com/SmiteshP/nvim-navic/commit/bf587250f8e399da75b4efe12261e18d8783ecef With `color_correction` set to "static" or "dynamic", navic uses the lualine section's background color when building the breadcrumbs text. * https://github.com/SmiteshP/nvim-navic/blob/bf587250f8e399da75b4efe12261e18d8783ecef/doc/navic.txt#L83-L88 I chose to set color_correction to "dynamic" to provide the best user experience as that will update the background any time the lualine section's background changes (e.g. when switching modes). ## Related Issue(s) * Fixes #328 ## Screenshots Before this fix, the breadcrumb's background did not match lualine section_c's: ![before](https://github.com/user-attachments/assets/b30e9844-5aac-4ec8-96fd-a5243de8cded) After this fix, the breadcrumb's background does match: ![after](https://github.com/user-attachments/assets/63945c48-2edc-4aea-8144-ae0bff1ed952) ## Checklist - [x] I've read the [CONTRIBUTING](https://github.com/LazyVim/LazyVim/blob/main/CONTRIBUTING.md) guidelines.
2024-11-08 05:08:43 -08:00
table.insert(opts.sections.lualine_c, { "navic", color_correction = "dynamic" })
end
2023-10-11 22:36:45 +02:00
end,
},
}