nixvim docs

plugins.image.enable

Whether to enable image.nvim.

Type: boolean

Default: false

Example: true

Declared by:

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

plugins.image.package

The image.nvim package to use.

Type: package

Default: pkgs.vimPlugins.image-nvim

Declared by:

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

plugins.image.backend

All the backends support rendering inside Tmux.

• kitty - best in class, works great and is very snappy

• ueberzug - backed by ueberzugpp, supports any terminal, but has lower performance

  • Supports multiple images thanks to @jstkdng.

Type: null or one of “kitty”, “ueberzug” or raw lua code

Default: null

Plugin default: "kitty"

Declared by:

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

plugins.image.curlPackage

The curl package to use.

Type: null or package

Default: pkgs.curl

Declared by:

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

plugins.image.editorOnlyRenderWhenFocused

Auto show/hide images when the editor gains/looses focus.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

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

plugins.image.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

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

plugins.image.hijackFilePatterns

Render image files as images when opened.

Type: null or (list of (string or raw lua code))

Default: null

Plugin default:

[
  "*.png"
  "*.jpg"
  "*.jpeg"
  "*.gif"
  "*.webp"
]

Declared by:

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

plugins.image.maxHeight

Image maximum height.

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

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

plugins.image.maxHeightWindowPercentage

Image maximum height as a percentage of the window height.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 50

Declared by:

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

plugins.image.maxWidth

Image maximum width.

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

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

plugins.image.maxWidthWindowPercentage

Image maximum width as a percentage of the window width.

Type: null or (unsigned integer, meaning >=0)

Default: null

Declared by:

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

plugins.image.tmuxShowOnlyInActiveWindow

Auto show/hide images in the correct Tmux window (needs visual-activity off).

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

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

plugins.image.ueberzugPackage

The ueberzug package to use.

Type: null or package

Default: pkgs.ueberzug

Declared by:

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

plugins.image.windowOverlapClearEnabled

Toggles images when windows are overlapped.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

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

plugins.image.windowOverlapClearFtIgnore

Toggles images when windows are overlapped.

Type: null or (list of (string or raw lua code))

Default: null

Plugin default:

[
  "cmp_menu"
  "cmp_docs"
  ""
]

Declared by:

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