plugins.image.enable
Whether to enable image.nvim.
Type: boolean
Default:
false
Example:
true
Declared by:
plugins.image.package
Which package to use for the image.nvim plugin.
Type: package
Default:
<derivation vimplugin-lua5.1-image.nvim-1.2.0-1-unstable-2024-05-14>
Declared by:
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.
Plugin default: "kitty"
Type: null or one of “kitty”, “ueberzug” or raw lua code
Default:
null
Declared by:
plugins.image.editorOnlyRenderWhenFocused
Auto show/hide images when the editor gains/looses focus.
Plugin default: false
Type: null or boolean or raw lua code
Default:
null
Declared by:
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:
plugins.image.hijackFilePatterns
Render image files as images when opened.
Plugin default: ["*.png" "*.jpg" "*.jpeg" "*.gif" "*.webp"]
Type: null or (list of (string or raw lua code))
Default:
null
Declared by:
plugins.image.maxHeight
Image maximum height.
Type: null or (unsigned integer, meaning >=0)
Default:
null
Declared by:
plugins.image.maxHeightWindowPercentage
Image maximum height as a percentage of the window height.
Plugin default: 50
Type: null or unsigned integer, meaning >=0, or raw lua code
Default:
null
Declared by:
plugins.image.maxWidth
Image maximum width.
Type: null or (unsigned integer, meaning >=0)
Default:
null
Declared by:
plugins.image.maxWidthWindowPercentage
Image maximum width as a percentage of the window width.
Type: null or (unsigned integer, meaning >=0)
Default:
null
Declared by:
plugins.image.tmuxShowOnlyInActiveWindow
Auto show/hide images in the correct Tmux window (needs visual-activity off).
Plugin default: false
Type: null or boolean or raw lua code
Default:
null
Declared by:
plugins.image.windowOverlapClearEnabled
Toggles images when windows are overlapped.
Plugin default: false
Type: null or boolean or raw lua code
Default:
null
Declared by:
plugins.image.windowOverlapClearFtIgnore
Toggles images when windows are overlapped.
Plugin default: ["cmp_menu" "cmp_docs" ""]
Type: null or (list of (string or raw lua code))
Default:
null
Declared by: