Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

navbuddy

URL: https://github.com/SmiteshP/nvim-navbuddy/


A simple popup display that provides a breadcrumbs feature using an LSP server.

plugins.navbuddy.enable

Whether to enable navbuddy.

Type: boolean

Default: false

Example: true

Declared by:

plugins.navbuddy.package

The navbuddy package to use.

Type: package

Default: pkgs.vimPlugins.nvim-navbuddy

Declared by:

plugins.navbuddy.autoLoad

Whether to automatically load navbuddy when neovim starts.

Type: boolean

Default: false when lazy-loading is enabled.

Example: false

Declared by:

plugins.navbuddy.settings

Options provided to the require('nvim-navbuddy').setup function.

Type: open submodule of attribute set of anything

Default: { }

Example:

{
  icons = {
    Array = "> ";
    Boolean = "> ";
    Class = "> ";
  };
  lsp = {
    auto_attach = true;
  };
  mappings = {
    "<C-s>" = lib.nixvim.mkRaw "require('nvim-navbuddy.actions').hsplit()";
    "<C-v>" = lib.nixvim.mkRaw "require('nvim-navbuddy.actions').vsplit()";
    "<esc>" = lib.nixvim.mkRaw "require('nvim-navbuddy.actions').close()";
    j = lib.nixvim.mkRaw "require('nvim-navbuddy.actions').next_sibling()";
    k = lib.nixvim.mkRaw "require('nvim-navbuddy.actions').previous_sibling()";
    q = lib.nixvim.mkRaw "require('nvim-navbuddy.actions').close()";
  };
  use_default_mapping = true;
}

Declared by: