nixvim docs

plugins.which-key.enable

Whether to enable which-key.nvim, a plugin that popup with possible key bindings of the command you started typing.

Type: boolean

Default: false

Example: true

Declared by:

• <nixvim/plugins/utils/which-key.nix>

plugins.which-key.package

Which package to use for the which-key-nvim plugin.

Type: package

Default: <derivation vimplugin-which-key.nvim-2023-10-20>

Declared by:

• <nixvim/plugins/utils/which-key.nix>

plugins.which-key.hidden

hide mapping boilerplate

Plugin default:

["<silent>" "<cmd>" "<Cmd>" "<CR>" "^:" "^ " "^call " "^lua "]

Type: null or (list of string)

Default: null

Declared by:

• <nixvim/plugins/utils/which-key.nix>

plugins.which-key.ignoreMissing

enable this to hide mappings for which you didn’t specify a label

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

• <nixvim/plugins/utils/which-key.nix>

plugins.which-key.keyLabels

override the label used to display some keys. It doesn’t effect WK in any other way.

Plugin default: {}

Type: null or (attribute set of string)

Default: null

Declared by:

• <nixvim/plugins/utils/which-key.nix>

plugins.which-key.operators

add operators that will trigger motion and text object completion to enable all native operators, set the preset / operators plugin above

Plugin default: {gc = "Comments";}

Type: null or (attribute set of string)

Default: null

Declared by:

• <nixvim/plugins/utils/which-key.nix>

plugins.which-key.registrations

Manually register the description of mappings.

Type: attribute set of anything

Default: { }

Example:

{
  "<leader>p" = "Find git files with telescope";
}

Declared by:

• <nixvim/plugins/utils/which-key.nix>

plugins.which-key.showHelp

show a help message in the command line for using WhichKey

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

• <nixvim/plugins/utils/which-key.nix>

plugins.which-key.showKeys

show the currently pressed key and its label as a message in the command line

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

• <nixvim/plugins/utils/which-key.nix>

plugins.which-key.triggers

automatically setup triggers, or specify a list manually

Plugin default: "auto"

Type: null or value “auto” (singular enum) or list of string

Default: null

Declared by:

• <nixvim/plugins/utils/which-key.nix>

plugins.which-key.triggersBlackList

list of mode / prefixes that should never be hooked by WhichKey this is mostly relevant for keymaps that start with a native binding

Plugin default: { i = ["j" "k"]; v = ["j" "k"]}}

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

Default: null

Declared by:

• <nixvim/plugins/utils/which-key.nix>

plugins.which-key.triggersNoWait

list of triggers, where WhichKey should not wait for timeoutlen and show immediately

Plugin default: ["" “'” "g" "g'" "\"" "<c-r>" "z="]

Type: null or (list of string)

Default: null

Declared by:

• <nixvim/plugins/utils/which-key.nix>