Appendix A. Configuration Options

Additional arguments passed to each module in addition to ones like `lib`, `config`, and `pkgs`, `modulesPath`. This option is also available to all submodules. Submodules do not inherit args from their parent module, nor do they provide args to their parent module or sibling submodules. The sole exception to this is the argument `name` which is provided by parent modules to a submodule and contains the attribute name the submodule is bound to, or a unique generated name if it is not bound to an attribute. Some arguments are already passed by default, of which the following *cannot* be changed with this option: - {var}`lib`: The nixpkgs library. - {var}`config`: The results of all options after merging the values from all modules together. - {var}`options`: The options declared in all modules. - {var}`specialArgs`: The `specialArgs` argument passed to `evalModules`. - All attributes of {var}`specialArgs` Whereas option values can generally depend on other option values thanks to laziness, this does not apply to `imports`, which must be computed statically before anything else. For this reason, callers of the module system can provide `specialArgs` which are available during import resolution. For NixOS, `specialArgs` includes {var}`modulesPath`, which allows you to import extra modules from the nixpkgs package tree without having to somehow make the module aware of the location of the `nixpkgs` or NixOS directories. ``` { modulesPath, ... }: { imports = [ (modulesPath + "/profiles/minimal.nix") ]; } ``` For NixOS, the default value for this option includes at least this argument: - {var}`pkgs`: The nixpkgs package set according to the {option}`nixpkgs.pkgs` option.

Type: lazy attribute set of raw value

Declared by:

Whether to enable enable nixneovim.

Type: boolean

Default: false

Example: true

The package to use for neovim.

Type: null or package

Default: null

Custom autocmd groups

Type: attribute set of (submodule)

Default: { }

Example:

''
  augroups.highlightOnYank = {
    autocmds = [{
      event = "TextYankPost";
      pattern = "*";
      luaCallback = '''
        vim.highlight.on_yank {
          higroup = (
            vim.fn['hlexists'] 'HighlightedyankRegion' > 0 and 'HighlightedyankRegion' or 'IncSearch'
          ),
          timeout = 200,
        }
      ''';
    }];
  };
''

The autocmds that are part of this augroup. See :help nvim_create_autocmd()

Type: list of (submodule)

buffer number for buffer-local autocommands. Cannot be used with pattern.

Type: null or signed integer

Default: null

Vim command to execute on event. Cannot be used with {lua,vim}Callback

Type: null or string

Default: null

description (for documentation and troubleshooting)

Type: null or strings concatenated with "\n"

Default: null

Event(s) that will trigger the handler (callback or command).

Type: string or list of string

Lua function called when the event(s) is triggered. Can return true to delete the autocommand, and receives a table argument (opts) with these keys: • id: (number) autocommand id • event: (string) name of the triggered event |autocmd-events| • group: (number|nil) autocommand group id, if any • match: (string) expanded value of |<amatch>| • buf: (number) expanded value of |<abuf>| • file: (string) expanded value of |<afile>| • data: (any) arbitrary data passed from |nvim_exec_autocmds()| Will be expanded to: ```lua function(opts) ${luaCallback} end ```

Type: null or strings concatenated with "\n"

Default: null

Example:

''
  vim.highlight.on_yank {
    higroup = (
      vim.fn['hlexists'] 'HighlightedyankRegion' > 0 and 'HighlightedyankRegion' or 'IncSearch'
    ),
    timeout = 200,
  }
''

Run nested autocommands

Type: null or boolean

Default: false

Run the autocommand only once

Type: null or boolean

Default: false

Pattern(s) to match literally. Note: `pattern` is NOT automatically expanded (unlike with |:autocmd|), thus names like "$HOME" and "~" must be expanded explicitly.

Type: null or string or list of string

Default: null

Vimscript function name called when the event(s) is triggered. Conflicts with luaCallback

Type: null or string

Default: null

Clear existing commands if the group already exists.

Type: null or boolean

Default: true

The name of the augroup. If undefined, the name of the attribute set will be used.

Type: string

The name of the colorscheme

Type: null or string

Default: null

Whether to enable Enable the bamboo plugin.

.

Type: boolean

Default: false

Example: true

Show the end-of-buffer tildes. By default they are hidden

Type: null or boolean

Default: false

You can configure multiple style with comma separated, For e.g., keywords = 'italic,bold'

Type: null or string

Default: "italic"

You can configure multiple style with comma separated, For e.g., keywords = 'italic,bold'

Type: null or string

Default: "none"

You can configure multiple style with comma separated, For e.g., keywords = 'italic,bold'

Type: null or string

Default: "none"

You can configure multiple style with comma separated, For e.g., keywords = 'italic,bold'

Type: null or string

Default: "none"

You can configure multiple style with comma separated, For e.g., keywords = 'italic,bold'

Type: null or string

Default: "none"

use undercurl instead of underline for diagnostics

Type: null or boolean

Default: true

Type: null or boolean

Default: false

darker colors for diagnostic

Type: null or boolean

Default: true

Change terminal color as per the selected theme style

Type: null or boolean

Default: false

Place any extra config here as an attibute-set

Type: attribute set of anything

Default: { }

Place any extra lua code here that is loaded after the plugin is loaded

Type: string

Default: ""

Place any extra lua code here that is loaded before the plugin is loaded

Type: string

Default: ""

Type: null or boolean

Default: false

Type: null or one of "vulgaris", "multiplex"

Default: "vulgaris"

Show/hide background

Type: null or boolean

Default: true

Type: null or (list of anything)

Default:

[
  "vulgaris"
  "multiplex"
]

List of styles to toggle between (this option is essentially pointless now but will become useful if more style variations are added)

Type: null or boolean

Default: false

Whether to enable base16.

Type: boolean

Default: false

Example: true

The base16 colorscheme to use

Type: one of "3024", "apathy", "ashes", "atelier-cave-light", "atelier-cave", "atelier-dune-light", "atelier-dune", "atelier-estuary-light", "atelier-estuary", "atelier-forest-light", "atelier-forest", "atelier-heath-light", "atelier-heath", "atelier-lakeside-light", "atelier-lakeside", "atelier-plateau-light", "atelier-plateau", "atelier-savanna-light", "atelier-savanna", "atelier-seaside-light", "atelier-seaside", "atelier-sulphurpool-light", "atelier-sulphurpool", "atlas", "bespin", "black-metal-bathory", "black-metal-burzum", "black-metal-dark-funeral", "black-metal-gorgoroth", "black-metal-immortal", "black-metal-khold", "black-metal-marduk", "black-metal-mayhem", "black-metal-nile", "black-metal-venom", "black-metal", "brewer", "bright", "brogrammer", "brushtrees-dark", "brushtrees", "chalk", "circus", "classic-dark", "classic-light", "codeschool", "cupcake", "cupertino", "darktooth", "default-dark", "default-light", "dracula", "eighties", "embers", "flat", "fruit-soda", "github", "google-dark", "google-light", "grayscale-dark", "grayscale-light", "greenscreen", "gruvbox-dark-hard", "gruvbox-dark-medium", "gruvbox-dark-pale", "gruvbox-dark-soft", "gruvbox-light-hard", "gruvbox-light-medium", "gruvbox-light-soft", "harmonic-dark", "harmonic-light", "heetch-light", "heetch", "helios", "hopscotch", "horizon-dark", "ia-dark", "ia-light", "icy", "irblack", "isotope", "macintosh", "marrakesh", "material-darker", "material-lighter", "material-palenight", "material", "material-vivid", "materia", "mellow-purple", "mexico-light", "mocha", "monokai", "nord", "oceanicnext", "ocean", "onedark", "one-light", "outrun-dark", "papercolor-dark", "papercolor-light", "paraiso", "phd", "pico", "pop", "porple", "railscasts", "rebecca", "seti", "shapeshifter", "snazzy", "solarflare", "solarized-dark", "solarized-light", "spacemacs", "summerfruit-dark", "summerfruit-light", "synth-midnight-dark", "tomorrow-night-eighties", "tomorrow-night", "tomorrow", "tube", "twilight", "unikitty-dark", "unikitty-light", "woodland", "xcode-dusk", "zenburn"

Default: "default-dark"

Whether to install the matching plugin for your statusbar. This does nothing as of yet, waiting for upstream support.

Type: boolean

Default: true

Whether to use truecolor for the colorschemes. If set to false, you'll need to set up base16 in your shell.

Type: boolean

Default: true

Whether to enable Enable the catppuccin plugin.

.

Type: boolean

Default: false

Example: true

Type: null or string

Default: "mocha"

Type: null or string

Default: "latte"

Dim background color of active window.

Type: null or boolean

Default: false

Percentage of the shade to apply to inactive window.

Type: null or floating point number

Default: 0.15

Set shade of dim color.

Type: null or string

Default: "dark"

Place any extra config here as an attibute-set

Type: attribute set of anything

Default: { }

Place any extra lua code here that is loaded after the plugin is loaded

Type: string

Default: ""

Place any extra lua code here that is loaded before the plugin is loaded

Type: string

Default: ""

Set flavour of Catppuccin theme.

Type: null or one of "latte", "frappe", "macchiato", "mocha"

Default: "mocha"

Type: null or boolean

Default: true

Type: null or boolean

Default: true

Type: null or boolean

Default: true

Type: null or string

Default: ""

Type: null or boolean

Default: false

Type: null or boolean

Default: true

Type: null or boolean

Default: true

Force no bold.

Type: null or boolean

Default: false

Force no italic.

Type: null or boolean

Default: false

Force no underline.

Type: null or boolean

Default: false

Show '~' character after the end of buffers.

Type: null or boolean

Default: false

Change the style of comments.

Type: null or (list of anything)

Default:

[
  "italic"
]

Type: null or (list of anything)

Default:

[
  "italic"
]

Set terminal colors.

Type: null or boolean

Default: false

Disable setting the background color.

Type: null or boolean

Default: false

Whether to enable Enable the gruvbox-baby plugin.

.

Type: boolean

Default: false

Example: true

Type: null or one of "medium", "dark"

Default: "medium"

Override color palette with your custom colors

Type: null or (attribute set of anything)

Default: { }

See :h attr-list

Type: null or string

Default: "italic"

Place any extra config here as an attibute-set

Type: attribute set of anything

Default: { }

Place any extra lua code here that is loaded after the plugin is loaded

Type: string

Default: ""

Place any extra lua code here that is loaded before the plugin is loaded

Type: string

Default: ""

See :h attr-list

Type: null or string

Default: "bold"

Override highlights with your custom highlights

Type: null or (attribute set of anything)

Default: { }

See :h attr-list

Type: null or string

Default: "italic"

See :h attr-list

Type: null or string

Default: "nocombine"

Set background colors to None

Type: null or boolean

Default: false

Use the original gruvbox palette

Type: null or boolean

Default: false

See :h attr-list

Type: null or string

Default: "NONE"

Whether to enable Enable the gruvbox-material plugin.

.

Type: boolean

Default: false

Example: true

To enable bold in function name just like the original gruvbox, set this option to `1`.

Type: null or boolean

Default: false

To enable italic in this color scheme, set this option to `1`.

Type: null or boolean

Default: false

The background contrast used in this color scheme

Type: null or one of "hard", "medium", "soft"

Default: "medium"

The loading time of this color scheme is very long because too many file types and plugins are optimized. This feature allows you to load part of the code on demand by placing them in the `after/syntax` directory. Enabling this option will reduce loading time by approximately 50%.

Type: null or boolean

Default: false

Dim inactive windows. Only works in neovim currently.

Type: null or boolean

Default: false

By default, italic is enabled in `Comment`. To disable italic in `Comment`, set this option to `1`.

Type: null or boolean

Default: false

Place any extra config here as an attibute-set

Type: attribute set of anything

Default: { }

Place any extra lua code here that is loaded after the plugin is loaded

Type: string

Default: ""

Place any extra lua code here that is loaded before the plugin is loaded

Type: string

Default: ""

The foreground color palette used in this color scheme. - `material`: Carefully designed to have a soft contrast. - `mix`: Color palette obtained by calculating the mean of the other two. - `original`: The color palette used in the original gruvbox.

Type: null or one of "material", "mix", "original"

Default: "material"

If you want more ui components to be transparent (for example, status line background), set this option to `2`.

Type: null or signed integer

Default: 0

Whether to enable Enable the gruvbox-morhetz plugin.

.

Type: boolean

Default: false

Example: true

Place any extra config here as an attibute-set

Type: attribute set of anything

Default: { }

Place any extra lua code here that is loaded after the plugin is loaded

Type: string

Default: ""

Place any extra lua code here that is loaded before the plugin is loaded

Type: string

Default: ""

Whether to enable gruvbox-nvim.

Type: boolean

Default: false

Example: true

Whether to enable bold.

Type: boolean

Default: false

Example: true

The color column background

Type: null or one of "bg", "red", "green", "yellow", "blue", "purple", "aqua", "gray", "fg", "bg0_h", "bg0", "bg1", "bg2", "bg3", "bg4", "gray", "orange", "bg0_s", "fg0", "fg1", "fg2", "fg3", "fg4"

Default: null

Contrast for the dark mode

Type: null or one of "soft", "medium", "hard"

Default: null

Contrast for the light mode

Type: null or one of "soft", "medium", "hard"

Default: null

The cursor background while search is highlighted

Type: null or one of "bg", "red", "green", "yellow", "blue", "purple", "aqua", "gray", "fg", "bg0_h", "bg0", "bg1", "bg2", "bg3", "bg4", "gray", "orange", "bg0_s", "fg0", "fg1", "fg2", "fg3", "fg4"

Default: null

Improved strings

Type: boolean

Default: false

Improved warnings

Type: boolean

Default: false

Invert indent guides

Type: boolean

Default: false

Invert the select text

Type: boolean

Default: true

Invert GitGutter and Syntastic signs

Type: boolean

Default: false

Invert tabline highlights

Type: boolean

Default: false

Italicize comments

Type: boolean

Default: true

Italicize strings

Type: boolean

Default: false

Whether to enable italics.

Type: boolean

Default: false

Example: true

The number column background

Type: null or one of "bg", "red", "green", "yellow", "blue", "purple", "aqua", "gray", "fg", "bg0_h", "bg0", "bg1", "bg2", "bg3", "bg4", "gray", "orange", "bg0_s", "fg0", "fg1", "fg2", "fg3", "fg4"

Default: null

The sign column background

Type: null or one of "bg", "red", "green", "yellow", "blue", "purple", "aqua", "gray", "fg", "bg0_h", "bg0", "bg1", "bg2", "bg3", "bg4", "gray", "orange", "bg0_s", "fg0", "fg1", "fg2", "fg3", "fg4"

Default: null

Whether to enable Transparent background.

Type: boolean

Default: false

Example: true

Whether to enable true color support.

Type: boolean

Default: false

Example: true

Whether to enable undercurled text.

Type: boolean

Default: false

Example: true

Whether to enable underlined text.

Type: boolean

Default: false

Example: true

The vertical split background color

Type: null or one of "bg", "red", "green", "yellow", "blue", "purple", "aqua", "gray", "fg", "bg0_h", "bg0", "bg1", "bg2", "bg3", "bg4", "gray", "orange", "bg0_s", "fg0", "fg1", "fg2", "fg3", "fg4"

Default: null

Whether to enable Enable the kanagawa plugin.

.

Type: boolean

Default: false

Example: true

Type: null or string

Default: "wave"

Type: null or string

Default: "lotus"

Type: null or boolean

Default: true

Type: null or boolean

Default: false

Type: null or boolean

Default: false

Place any extra config here as an attibute-set

Type: attribute set of anything

Default: { }

Place any extra lua code here that is loaded after the plugin is loaded

Type: string

Default: ""

Place any extra lua code here that is loaded before the plugin is loaded

Type: string

Default: ""

Type: null or boolean

Default: true

Type: null or boolean

Default: true

Type: null or boolean

Default: true

Type: null or string

Default: "wave"

Type: null or boolean

Default: false

Type: null or boolean

Default: true

Whether to enable nord.

Type: boolean

Default: false

Example: true

Whether to enable Re-enables the background of the sidebar if you disabled the background of everything.

Type: boolean

Default: false

Example: true

Whether to enable Enable the border between verticaly split windows visable.

Type: boolean

Default: false

Example: true

Whether to enable Make sidebars and popup menus like nvim-tree and telescope have a different background.

Type: boolean

Default: false

Example: true

Whether to enable Set the cursorline transparent/visible.

Type: boolean

Default: false

Example: true

Whether to enable Disable the setting of background color so that NeoVim can use your terminal background.

Type: boolean

Default: false

Example: true

enables/disables italics

Type: null or boolean

Default: null

Whether to enable vim-one.

Type: boolean

Default: false

Example: true

Whether to enable onedark.

Type: boolean

Default: false

Example: true

Whether to enable Enable the rose-pine plugin.

.

Type: boolean

Default: false

Example: true

Disable bold vertical split

Type: null or boolean

Default: false

Type: null or one of "main", "moon", "dawn"

Default: "main"

Dim the nc background

Type: null or boolean

Default: false

Disable the background

Type: null or boolean

Default: false

Disable the float background

Type: null or boolean

Default: false

Disable italics

Type: null or boolean

Default: false

Place any extra config here as an attibute-set

Type: attribute set of anything

Default: { }

Place any extra lua code here that is loaded after the plugin is loaded

Type: string

Default: ""

Place any extra lua code here that is loaded before the plugin is loaded

Type: string

Default: ""

Set the color of the background

Type: null or one of "base", "surface", "overlay", "muted", "subtle", "text", "love", "gold", "rose", "pine", "foam", "iris", "highlight_low", "highlight_med", "highlight_high", "_experimental_nc"

Default: "base"

Sets the color of the nc background

Type: null or one of "base", "surface", "overlay", "muted", "subtle", "text", "love", "gold", "rose", "pine", "foam", "iris", "highlight_low", "highlight_med", "highlight_high", "_experimental_nc"

Default: "_experimental_nc"

Set the color of the border

Type: null or one of "base", "surface", "overlay", "muted", "subtle", "text", "love", "gold", "rose", "pine", "foam", "iris", "highlight_low", "highlight_med", "highlight_high", "_experimental_nc"

Default: "highlight_med"

Set the color of the comments

Type: null or one of "base", "surface", "overlay", "muted", "subtle", "text", "love", "gold", "rose", "pine", "foam", "iris", "highlight_low", "highlight_med", "highlight_high", "_experimental_nc"

Default: "muted"

Set the color of errors

Type: null or one of "base", "surface", "overlay", "muted", "subtle", "text", "love", "gold", "rose", "pine", "foam", "iris", "highlight_low", "highlight_med", "highlight_high", "_experimental_nc"

Default: "love"

Set the color of hints

Type: null or one of "base", "surface", "overlay", "muted", "subtle", "text", "love", "gold", "rose", "pine", "foam", "iris", "highlight_low", "highlight_med", "highlight_high", "_experimental_nc"

Default: "iris"

Set the color of info

Type: null or one of "base", "surface", "overlay", "muted", "subtle", "text", "love", "gold", "rose", "pine", "foam", "iris", "highlight_low", "highlight_med", "highlight_high", "_experimental_nc"

Default: "foam"

Set the color of the links

Type: null or one of "base", "surface", "overlay", "muted", "subtle", "text", "love", "gold", "rose", "pine", "foam", "iris", "highlight_low", "highlight_med", "highlight_high", "_experimental_nc"

Default: "iris"

Set the color of the panel

Type: null or one of "base", "surface", "overlay", "muted", "subtle", "text", "love", "gold", "rose", "pine", "foam", "iris", "highlight_low", "highlight_med", "highlight_high", "_experimental_nc"

Default: "surface"

Set the color of the panel nc

Type: null or one of "base", "surface", "overlay", "muted", "subtle", "text", "love", "gold", "rose", "pine", "foam", "iris", "highlight_low", "highlight_med", "highlight_high", "_experimental_nc"

Default: "base"

Set the color of the punctuation

Type: null or one of "base", "surface", "overlay", "muted", "subtle", "text", "love", "gold", "rose", "pine", "foam", "iris", "highlight_low", "highlight_med", "highlight_high", "_experimental_nc"

Default: "subtle"

Set the color of warnings

Type: null or one of "base", "surface", "overlay", "muted", "subtle", "text", "love", "gold", "rose", "pine", "foam", "iris", "highlight_low", "highlight_med", "highlight_high", "_experimental_nc"

Default: "gold"

Set the color of heading 1

Type: null or one of "base", "surface", "overlay", "muted", "subtle", "text", "love", "gold", "rose", "pine", "foam", "iris", "highlight_low", "highlight_med", "highlight_high", "_experimental_nc"

Default: "iris"

Set the color of heading 2

Type: null or one of "base", "surface", "overlay", "muted", "subtle", "text", "love", "gold", "rose", "pine", "foam", "iris", "highlight_low", "highlight_med", "highlight_high", "_experimental_nc"

Default: "foam"

Set the color of heading 3

Type: null or one of "base", "surface", "overlay", "muted", "subtle", "text", "love", "gold", "rose", "pine", "foam", "iris", "highlight_low", "highlight_med", "highlight_high", "_experimental_nc"

Default: "rose"

Set the color of heading 4

Type: null or one of "base", "surface", "overlay", "muted", "subtle", "text", "love", "gold", "rose", "pine", "foam", "iris", "highlight_low", "highlight_med", "highlight_high", "_experimental_nc"

Default: "gold"

Set the color of heading 5

Type: null or one of "base", "surface", "overlay", "muted", "subtle", "text", "love", "gold", "rose", "pine", "foam", "iris", "highlight_low", "highlight_med", "highlight_high", "_experimental_nc"

Default: "pine"

Set the color of heading 6

Type: null or one of "base", "surface", "overlay", "muted", "subtle", "text", "love", "gold", "rose", "pine", "foam", "iris", "highlight_low", "highlight_med", "highlight_high", "_experimental_nc"

Default: "foam"

Change specific vim highlight groups

Type: null or (attribute set of anything)

Default: { }

Type: null or one of "auto", "main", "moon", "dawn"

Default: "auto"

Whether to enable Enable the tokyonight plugin.

.

Type: boolean

Default: false

Example: true

Whether to enable Float windows like the lsp diagnostics windows get a darker background.

Type: boolean

Default: false

Example: true

Whether to enable Sidebar like windows like NvimTree get a darker background.

Type: boolean

Default: false

Example: true

Place any extra config here as an attibute-set

Type: attribute set of anything

Default: { }

Place any extra lua code here that is loaded after the plugin is loaded

Type: string

Default: ""

Place any extra lua code here that is loaded before the plugin is loaded

Type: string

Default: ""

Whether to enable Enabling this option will hide inactive statuslines and replace them with a thin border.

Type: boolean

Default: false

Example: true

Whether to enable Make comments italic.

Type: boolean

Default: false

Example: true

Whether to enable Make functions italic.

Type: boolean

Default: false

Example: true

Whether to enable Make keywords italic.

Type: boolean

Default: false

Example: true

Whether to enable Make variables and identifiers italic.

Type: boolean

Default: false

Example: true

Whether to enable When true, section headers in the lualine theme will be bold.

Type: boolean

Default: false

Example: true

Theme style

Type: null or one of "storm", "night", "day"

Default: "storm"

Whether to enable Configure the colors used when opening a :terminal in Neovim.

Type: boolean

Default: false

Example: true

Whether to enable this to disable setting the background color.

Type: boolean

Default: false

Example: true

Whether to enable Sidebar like windows like NvimTree get a transparent background.

Type: boolean

Default: false

Example: true

Whether to enable Enable the vscode plugin.

.

Type: boolean

Default: false

Example: true

Whether to disable nvim-tree background color

Type: null or boolean

Default: true

Place any extra config here as an attibute-set

Type: attribute set of anything

Default: { }

Place any extra lua code here that is loaded after the plugin is loaded

Type: string

Default: ""

Place any extra lua code here that is loaded before the plugin is loaded

Type: string

Default: ""

Whether to enable italic comments

Type: null or boolean

Default: true

Theme style (light or dark)

Type: null or one of "dark", "light"

Default: "dark"

Whether to enable transparent background

Type: null or boolean

Default: true

Internal option

Type: attribute set of anything

Default: { }

Configures neovim to be the default editor using the EDITOR environment variable.

Type: boolean

Default: false

Extra contents for init.lua

Type: strings concatenated with "\n"

Default: ""

Extra contents for init.vim

Type: strings concatenated with "\n"

Default: ""

Extra contents for init.lua after everything else

Type: strings concatenated with "\n"

Default: ""

Extra contents for init.lua before everything else

Type: strings concatenated with "\n"

Default: ""

Extra packages to be made available to neovim

Type: list of package

Default: [ ]

Example: "[ pkgs.shfmt ]"

List of vim plugins to install.

Type: list of (package or (submodule))

Default: [ ]

Global variables

Type: attribute set of anything

Default: { }

Custom keybindings for any mode. For plain maps (e.g. just 'map' or 'remap') use maps.normalVisualOp.

Type: submodule

Default: { }

Example:

''
  maps = {
    normalVisualOp.";" = ":"; # Same as noremap ; :
    normal."<leader>m" = {
      silent = true;
      action = "<cmd>make<CR>";
    }; # Same as nnoremap <leader>m <silent> <cmd>make<CR>
  };
''

Mappings for command-line mode

Type: attribute set of (string or (submodule))

Default: { }

Mappings for insert mode

Type: attribute set of (string or (submodule))

Default: { }

Mappings for insert and command-line mode

Type: attribute set of (string or (submodule))

Default: { }

Mappings for insert, command-line and lang-arg mode

Type: attribute set of (string or (submodule))

Default: { }

Mappings for normal mode

Type: attribute set of (string or (submodule))

Default: { }

Mappings for normal, visual, select and operator-pending (same as plain 'map') mode

Type: attribute set of (string or (submodule))

Default: { }

Mappings for operator-pending mode

Type: attribute set of (string or (submodule))

Default: { }

Mappings for select mode

Type: attribute set of (string or (submodule))

Default: { }

Mappings for terminal mode

Type: attribute set of (string or (submodule))

Default: { }

Mappings for visual and select mode

Type: attribute set of (string or (submodule))

Default: { }

Mappings for visual only mode

Type: attribute set of (string or (submodule))

Default: { }

The configuration options, e.g. line numbers

Type: attribute set of anything

Default: { }

Whether to enable airline.

Type: boolean

Default: false

Example: true

A list of extensions and their configuration

Type: null or (attribute set)

Default: null

Whether to show the statusline on the top instead of the bottom

Type: boolean

Default: false

Whether to use powerline symbols

Type: boolean

Default: false

Statusbar sections

Type: null or (submodule)

Default: null

Configuration for this section. Can be either a statusline-format string or a list of modules to be passed to airline#section#create_*.

Type: null or string or list of string

Default: null

Configuration for this section. Can be either a statusline-format string or a list of modules to be passed to airline#section#create_*.

Type: null or string or list of string

Default: null

Configuration for this section. Can be either a statusline-format string or a list of modules to be passed to airline#section#create_*.

Type: null or string or list of string

Default: null

Configuration for this section. Can be either a statusline-format string or a list of modules to be passed to airline#section#create_*.

Type: null or string or list of string

Default: null

Configuration for this section. Can be either a statusline-format string or a list of modules to be passed to airline#section#create_*.

Type: null or string or list of string

Default: null

Configuration for this section. Can be either a statusline-format string or a list of modules to be passed to airline#section#create_*.

Type: null or string or list of string

Default: null

The theme to use for vim-airline. If set, vim-airline-themes will be installed.

Type: null or string

Default: null

Whether to enable Enable the asyncrun plugin.

.

Type: boolean

Default: false

Example: true

Place any extra config here as an attibute-set

Type: attribute set of anything

Default: { }

Place any extra lua code here that is loaded after the plugin is loaded

Type: string

Default: ""

Place any extra lua code here that is loaded before the plugin is loaded

Type: string

Default: ""

Whether to enable Enable the barbar plugin.

.

Type: boolean

Default: false

Example: true

Enable animations

Type: null or boolean

Default: true

Auto-hide the tab bar when there is only one buffer

Type: null or boolean

Default: false

Enable clickable tabs - left-click: go to buffer - middle-click: delete buffer

Type: null or boolean

Default: true

Enable the close button

Type: null or boolean

Default: true

Place any extra config here as an attibute-set

Type: attribute set of anything

Default: { }

Place any extra lua code here that is loaded after the plugin is loaded

Type: string

Default: ""

Place any extra lua code here that is loaded before the plugin is loaded

Type: string

Default: ""

Enable 'current/total' tabpages indicator in top right corner

Type: null or boolean

Default: true

Whether to enable Enable the bufdelete plugin.

.

Type: boolean

Default: false

Example: true

Place any extra config here as an attibute-set

Type: attribute set of anything

Default: { }

Place any extra lua code here that is loaded after the plugin is loaded

Type: string

Default: ""

Place any extra lua code here that is loaded before the plugin is loaded

Type: string

Default: ""

Whether to enable bufferline.

Type: boolean

Default: false

Example: true

Type: null or boolean

Default: null

The close icon for each buffer.

Type: null or string

Default: null

Command or function run when closing a buffer.

Type: null or strings concatenated with "\n"

Default: null

The close icon.

Type: null or string

Default: null

Type: null or strings concatenated with "\n"

Default: null

Type: null or one of false, "nvim_lsp", "coc"

Default: null

Type: null or strings concatenated with "\n"

Default: null

Type: null or boolean

Default: null

Type: null or boolean

Default: null

Type: null or (submodule)

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

Type: null or (submodule)

Default: null

background color

Type: null or string

Default: null

foreground color

Type: null or string

Default: null

The Icon shown as a indicator for buffer. Changing it is NOT recommended, this is intended to be an escape hatch for people who cannot bear it for whatever reason.

Type: null or string

Default: null

Command or function run when clicking on a buffer.

Type: null or strings concatenated with "\n"

Default: null

Type: null or string

Default: null

Max length of a buffer name.

Type: null or signed integer

Default: null

Max length of a buffer prefix (used when a buffer is de-duplicated)

Type: null or signed integer

Default: null

Command or function run when middle clicking on a buffer.

Type: null or strings concatenated with "\n"

Default: null

The icon indicating a buffer was modified.

Type: null or string

Default: null

A lua function that can be used to modify the buffer's lable. The argument 'buf' containing a name, path and bufnr is supplied.

Type: null or strings concatenated with "\n"

Default: null

A lua function customizing the styling of numbers.

Type: null or strings concatenated with "\n"

Default: null

Type: null or (list of (attribute set))

Default: null

Type: null or boolean

Default: null

Command or function run when right clicking on a buffer.

Type: null or strings concatenated with "\n"

Default: null

Type: null or string

Default: null

Type: null or one of "slant", "thick", "thin"

Default: null

Type: null or boolean

Default: null

Type: null or boolean

Default: null

Type: null or boolean

Default: null

Type: null or boolean

Default: null

Type: null or one of "id", "extension", "relative_directory", "directory", "tabs"

Default: null

Size of the tabs

Type: null or signed integer

Default: null

Whether to enable Enable the clangd-extensions plugin.

.

Type: boolean

Default: false

Example: true

Type: null or string

Default: "Comment"

Type: null or string

Default: "🄲"

Type: null or string

Default: "🄿"

Type: null or string

Default: "🅁"

Type: null or string

Default: "🅃"

Type: null or string

Default: "🅃"

Type: null or string

Default: "🅃"

Type: null or string

Default: "🅄"

Type: null or string

Default: "🄓"

Type: null or string

Default: "🄔"

Type: null or string

Default: "🄢"

Type: null or string

Default: ";"

Type: null or string

Default: "🆃"

Type: null or string

Default: "🄣"

Place any extra config here as an attibute-set

Type: attribute set of anything

Default: { }

Place any extra lua code here that is loaded after the plugin is loaded

Type: string

Default: ""

Place any extra lua code here that is loaded before the plugin is loaded

Type: string

Default: ""

The color of the hints

Type: null or string

Default: "Comment"

Options other than `highlight' and `priority' only work if `inline' is disabled

Type: rawLuaType

Default:

{
  __raw = "vim.fn.has(\"nvim-0.10\") == 1";
}

whether to align to the length of the longest line in the file

Type: null or boolean

Default: false

padding from the left if max_len_align is true

Type: null or signed integer

Default: 1

Only show inlay hints for the current line

Type: null or boolean

Default: false

Type: null or (list of anything)

Default:

[
  "CursorHold"
]

prefix for all the other hints (type, chaining)

Type: null or string

Default: "=> "

prefix for parameter hints

Type: null or string

Default: "<- "

The highlight group priority for extmark

Type: null or signed integer

Default: 100

whether to align to the extreme right or not

Type: null or boolean

Default: false

padding from the right if right_align is true

Type: null or signed integer

Default: 7

whether to show parameter hints with the inlay hints or not

Type: null or boolean

Default: true

Type: null or string

Default: "none"

Type: null or string

Default: "none"

Whether to enable Enable the colorizer plugin.

.

Type: boolean

Default: false

Example: true

Place any extra config here as an attibute-set

Type: attribute set of anything

Default: { }

Place any extra lua code here that is loaded after the plugin is loaded

Type: string

Default: ""

Place any extra lua code here that is loaded before the plugin is loaded

Type: string

Default: ""

Type: null or (list of anything)

Default:

[
  "*"
]

0xAARRGGBB hex codes

Type: null or boolean

Default: false

#RGB hex codes

Type: null or boolean

Default: true

#RRGGBB hex codes

Type: null or boolean

Default: true

#RRGGBBAA hex codes

Type: null or boolean

Default: false

Enable all CSS features: rgb_fn, hsl_fn, names, RGB, RRGGBB

Type: null or boolean

Default: false

Enable all CSS *functions*: rgb_fn, hsl_fn

Type: null or boolean

Default: false

CSS hsl() and hsla() functions

Type: null or boolean

Default: false

How to display the color

Type: null or one of "background", "foreground", "virtualtext"

Default: "background"

"Name" codes like Blue or blue

Type: null or boolean

Default: true

CSS rgb() and rgba() functions

Type: null or boolean

Default: false

Type: null or boolean

Default: false

Type: null or (list of anything)

Default:

[
  "css"
]

Enable tailwind colors

Type: null or boolean

Default: false

Type: null or string

Default: "■"

Whether to enable Enable the comment plugin.

.

Type: boolean

Default: false

Example: true

Place any extra config here as an attibute-set

Type: attribute set of anything

Default: { }

Place any extra lua code here that is loaded after the plugin is loaded

Type: string

Default: ""

Place any extra lua code here that is loaded before the plugin is loaded

Type: string

Default: ""

Lines to be ignored while comment/uncomment

Type: null or string

Default: null

Create basic (operator-pending) and extended mappings for NORMAL + VISUAL mode

Type: null or (submodule)

Default: null

operator-pending mapping. Includes 'gcc', 'gcb', 'gc[count]{motion}' and 'gb[count]{motion}'

Type: boolean

Default: true

extended mapping. Includes 'g>', 'g<', 'g>[count]{motion}' and 'g<[count]{motion}'

Type: boolean

Default: false

extra mapping. Includes 'gco', 'gc0', 'gcA'

Type: boolean

Default: true

LHS of operator-pending mappings in NORMAL + VISUAL mode

Type: null or (submodule)

Default: null

block-comment keymap

Type: string

Default: "gb"

line-comment keymap

Type: string

Default: "gc"

Add a space b/w comment and the line

Type: null or boolean

Default: null

Whether the cursor should stay at its position

Type: null or boolean

Default: null

LHS of toggle mappings in NORMAL + VISUAL mode

Type: null or (submodule)

Default: null

block-comment keymap

Type: string

Default: "gbc"

line-comment keymap

Type: string

Default: "gcc"

Whether to enable Enable the comment-frame plugin.

.

Type: boolean

Default: false

Example: true

Type: null or boolean

Default: true

Type: null or boolean

Default: true

Type: null or boolean

Default: false

Type: null or string

Default: "//"

Place any extra config here as an attibute-set

Type: attribute set of anything

Default: { }

Place any extra lua code here that is loaded after the plugin is loaded

Type: string

Default: ""

Place any extra lua code here that is loaded before the plugin is loaded

Type: string

Default: ""

Type: null or string

Default: "-"

Type: null or signed integer

Default: 70

Type: null or string

Default: "<leader>cc"

Type: null or signed integer

Default: 50

Type: null or string

Default: "<leader>C"

Type: null or string

Default: "//"

Whether to enable commentary.

Type: boolean

Default: false

Example: true

Whether to enable Enable the copilot plugin.

.

Type: boolean

Default: false

Example: true

Place any extra config here as an attibute-set

Type: attribute set of anything

Default: { }

Place any extra lua code here that is loaded after the plugin is loaded

Type: string

Default: ""

Place any extra lua code here that is loaded before the plugin is loaded

Type: string

Default: ""

Attribute set of file types

Type: attribute set of boolean

Default: { }

Example:

{
        "*": false,
        python: true
      }

Address of proxy server for Copilot

Type: null or string

Default: null

Example: "localhost:3128"

Whether to enable coq.

Type: boolean

Default: false

Example: true

Auto-start or shut up

Type: null or boolean or value "shut-up" (singular enum)

Default: null

Whether to enable Install coq-artifacts.

Type: boolean

Default: false

Example: true

Use the recommended keymaps

Type: null or boolean

Default: null

Whether to enable dashboard.

Type: boolean

Default: false

Example: true

Center section

Type: null or (list of (submodule))

Default: null

Item action

Type: null or string

Default: null

Item description

Type: string

Item icon

Type: null or string

Default: null

Item shortcut

Type: null or string

Default: null

Footer text

Type: null or (list of string)

Default: null

Header text

Type: null or (list of string)

Default: null

Whether to hide statusline in Dashboard buffer

Type: null or boolean

Default: null

Whether to hide tabline in Dashboard buffer

Type: null or boolean

Default: null

Preview options

Type: submodule

Default: { }

Command to print file contents

Type: null or string

Default: null

Path to preview file

Type: null or string

Default: null

The height of the preview file

Type: null or signed integer

Default: null

The width of the preview file

Type: null or signed integer

Default: null

Path to session file

Type: null or string

Default: null

Whether to enable Enable the diffview plugin.

.

Type: boolean

Default: false

Example: true

Show diffs for binaries

Type: null or boolean

Default: false

Place any extra config here as an attibute-set

Type: attribute set of anything

Default: { }

Place any extra lua code here that is loaded after the plugin is loaded

Type: string

Default: ""

Place any extra lua code here that is loaded before the plugin is loaded

Type: string

Default: ""

Requires nvim-web-devicons

Type: null or boolean

Default: true

Update views and index buffers when the git index changes

Type: null or boolean

Default: true

Whether to enable easyescape.

Type: boolean

Default: false

Example: true

Whether to enable Enable the emmet plugin.

.

Type: boolean

Default: false

Example: true

Place any extra config here as an attibute-set

Type: attribute set of anything

Default: { }

Place any extra lua code here that is loaded after the plugin is loaded

Type: string

Default: ""

Place any extra lua code here that is loaded before the plugin is loaded

Type: string

Default: ""

Set leader key

Type: null or string

Default: "<C-Y>"

Mode where emmet will enable

Type: null or one of "i", "n", "v", "a"

Default: "n"

Emmet settings

Type: null or (attribute set of anything)

Default: { }

Whether to enable Enable the endwise plugin.

.

Type: boolean

Default: false

Example: true

Place any extra config here as an attibute-set

Type: attribute set of anything

Default: { }

Place any extra lua code here that is loaded after the plugin is loaded

Type: string

Default: ""

Place any extra lua code here that is loaded before the plugin is loaded

Type: string

Default: ""

Whether to enable Enable the firenvim plugin.

.

Type: boolean

Default: false

Example: true

Place any extra config here as an attibute-set

Type: attribute set of anything

Default: { }

Place any extra lua code here that is loaded after the plugin is loaded

Type: string

Default: ""

Place any extra lua code here that is loaded before the plugin is loaded

Type: string

Default: ""

Whether to enable floaterm.

Type: boolean

Default: false

Example: true

Whether to close floaterm window once the job gets finished.

Type: null or one of 0, 1, 2

Default: null

Whether to hide previous floaterm before switching to or opening another one.

Type: null or one of 0, 1, 2

Default: null

Whether to enter Terminal-mode after opening a floaterm.

Type: null or boolean

Default: null

8 characters of the floating window border (top, right, bottom, left, topleft, topright, botright, botleft)

Type: null or string

Default: null

Command used for opening a file in the outside nvim from within :terminal

Type: null or one of "edit", "split", "vsplit", "tabe", "drop"

Default: null

Markers used to detect the project root directory for --cwd=<root>

Type: null or (list of string)

Default: null

Type: null or string

Default: null

Show floaterm info at the top left corner of the floaterm window.

Type: null or string