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

nvim-tree

URL: https://github.com/nvim-tree/nvim-tree.lua/

Maintainers: Saygo


A file explorer tree for neovim written in lua.

plugins.nvim-tree.enable

Whether to enable nvim-tree.lua.

Type: boolean

Default: false

Example: true

Declared by:

plugins.nvim-tree.package

The nvim-tree.lua package to use.

Type: package

Default: pkgs.vimPlugins.nvim-tree-lua

Declared by:

plugins.nvim-tree.autoClose

Automatically close

Type: boolean

Default: false

Declared by:

plugins.nvim-tree.autoLoad

Whether to automatically load nvim-tree.lua when neovim starts.

Type: boolean

Default: false when lazy-loading is enabled.

Example: false

Declared by:

plugins.nvim-tree.ignoreBufferOnSetup

Will ignore the buffer, when deciding to open the tree on setup.

Type: boolean

Default: false

Declared by:

plugins.nvim-tree.ignoreFtOnSetup

List of filetypes that will prevent open_on_setup to open. You can use this option if you don’t want the tree to open in some scenarios (eg using vim startify).

Type: list of string

Default: [ ]

Declared by:

plugins.nvim-tree.openOnSetup

Will automatically open the tree when running setup if startup buffer is a directory, is empty or is unnamed. nvim-tree window will be focused.

Type: boolean

Default: false

Declared by:

plugins.nvim-tree.openOnSetupFile

Will automatically open the tree when running setup if startup buffer is a file. File window will be focused. File will be found if updateFocusedFile is enabled.

Type: boolean

Default: false

Declared by:

plugins.nvim-tree.settings

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

Type: attribute set of anything

Default: { }

Example:

{
  callback = {
    __raw = ''
      function()
        print('nixvim')
      end
    '';
  };
  foo_bar = 42;
  hostname = "localhost:8080";
}

Declared by: