nixvim docs

plugins.instant.settings

The configuration options for instant without the instant_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

• foo_bar = 1 -> :setglobal instant_foo_bar=1
• hello = "world" -> :setglobal instant_hello="world"
• some_toggle = true -> :setglobal instant_some_toggle
• other_toggle = false -> :setglobal noinstant_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  cursor_hl_group_default = "Cursor";
  cursor_hl_group_user1 = "Cursor";
  cursor_hl_group_user2 = "Cursor";
  cursor_hl_group_user3 = "Cursor";
  cursor_hl_group_user4 = "Cursor";
  name_hl_group_default = "CursorLineNr";
  name_hl_group_user1 = "CursorLineNr";
  name_hl_group_user2 = "CursorLineNr";
  name_hl_group_user3 = "CursorLineNr";
  name_hl_group_user4 = "CursorLineNr";
  onlyCwd = true;
  username = "Joe";
}

Declared by:

• <nixvim/plugins/by-name/instant>

plugins.instant.settings.cursor_hl_group_default

Cursor highlight group for any other userr.

Type: null or string or raw lua code

Default: null

Plugin default: "Cursor"

Declared by:

• <nixvim/plugins/by-name/instant>

plugins.instant.settings.cursor_hl_group_user1

Cursor highlight group for user 1.

Type: null or string or raw lua code

Default: null

Plugin default: "Cursor"

Declared by:

• <nixvim/plugins/by-name/instant>

plugins.instant.settings.cursor_hl_group_user2

Cursor highlight group for user 2.

Type: null or string or raw lua code

Default: null

Plugin default: "Cursor"

Declared by:

• <nixvim/plugins/by-name/instant>

plugins.instant.settings.cursor_hl_group_user3

Cursor highlight group for user 3.

Type: null or string or raw lua code

Default: null

Plugin default: "Cursor"

Declared by:

• <nixvim/plugins/by-name/instant>

plugins.instant.settings.cursor_hl_group_user4

Cursor highlight group for user 4.

Type: null or string or raw lua code

Default: null

Plugin default: "Cursor"

Declared by:

• <nixvim/plugins/by-name/instant>

plugins.instant.settings.name_hl_group_default

Virtual text highlight group for any other user.

Type: null or string or raw lua code

Default: null

Plugin default: "CursorLineNr"

Declared by:

• <nixvim/plugins/by-name/instant>

plugins.instant.settings.name_hl_group_user1

Virtual text highlight group for user 1.

Type: null or string or raw lua code

Default: null

Plugin default: "CursorLineNr"

Declared by:

• <nixvim/plugins/by-name/instant>

plugins.instant.settings.name_hl_group_user2

Virtual text highlight group for user 2.

Type: null or string or raw lua code

Default: null

Plugin default: "CursorLineNr"

Declared by:

• <nixvim/plugins/by-name/instant>

plugins.instant.settings.name_hl_group_user3

Virtual text highlight group for user 3.

Type: null or string or raw lua code

Default: null

Plugin default: "CursorLineNr"

Declared by:

• <nixvim/plugins/by-name/instant>

plugins.instant.settings.name_hl_group_user4

Virtual text highlight group for user 4.

Type: null or string or raw lua code

Default: null

Plugin default: "CursorLineNr"

Declared by:

• <nixvim/plugins/by-name/instant>

plugins.instant.settings.only_cwd

Choose whether to share files only in the current working directory in session mode.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

• <nixvim/plugins/by-name/instant>

plugins.instant.settings.username

Username. Explicitly set to null if you do not want this option to be set.

Type: null or string or raw lua code

Default: null

Declared by:

• <nixvim/plugins/by-name/instant>