💻 Preview options

preview = {
 --- When `true`, newly attached buffers
 --- show preview.
 ---@type boolean
 enable = true,
 --- When `true`, hybrid mode is enabled
 --- on newly attached buffers.
 ---@type boolean
 enable_hybrid_mode = true,
 --- List of filetypes to enable preview
 --- for.
 ---@type string[]
 filetypes = { "help" },
 --- List of 'buftype' to ignore.
 ---@type string[]
 ignore_buftypes = {},
 --- Additional condition for attaching
 --- to new buffers.
 ---@type fun(buffer: integer): boolean
 condition = nil,
 ---Modes where previews are shown.
 ---@type string[]
 modes = { "n", "no", "c" },
 --- Modes where hybrid mode is used.
 ---@type string[]
 hybrid_modes = {},
 --- Enables linewise-hybrid mode.
 ---@type boolean
 linewise_hybrid_mode = false,
 --- Items that won't be affected by
 --- `hybrid mode`.
 ---@type preview.ignore
 ignore_previews = {},
 --- Debounce delay for updating previews.
 ---@type integer
 debounce = 150,
 --- Maximum number of lines a buffer can
 --- have for it to be rendered entirely.
 ---@type integer
 max_buf_lines = 1000,
 --- Number of lines above & below the cursor
 --- to parse and draw.
 ---@type [ integer, integer ]
 draw_range = { 2 * vim.o.lines, 2 * vim.o.lines },
 --- Number of lines above & below the cursor
 --- that will be affected by `hybrid mode.
 ---@type [ integer, integer ]
 edit_range = { 0, 0 },
 --- Callback functions.
 ---@type { [string]: function }
 callbacks = {},
 --- Window options for the splitview window.
 ---@type table.
 splitview_winopts = {},
 --- Window options for the overlay window in
 --- `:Help`.
 ---@type table.
 overlay_winopts = {},
 --- Window options for the preview window in
 --- `:Help`.
 ---@type table.
 preview_winopts = {},
 --- Icon provider for code blocks.
 ---@field icon_provider?
 ---| "internal" Internal icon provider.
 ---| "devicons" `nvim-web-devicons` as icon provider.
 ---| "mini" `mini.icons` as icon provider.
 icon_provider = "internal"
}

enable

Tip

You can set this to false in case you manually enable previews(:Helpview toggle).

enable_hybrid_mode

Tip

You can set this to false in case you use hybrid mode only sometimes(:Helpview hybridToggle).

filetypes

ignore_buftypes

condition

Note

This is done after matching filetypes & ignore_buftypes.

condition = function (buffer)
 local ft, bt = vim.bo[buffer].ft, vim.bo[buffer].bt;
 --- Only attaches to any kind of help
 --- files and `nofile` buffers(for the
 --- other filetypes).
 if ft == "help" then
 return true;
 elseif bt ~= "nofile" then
 return true;
 else
 return false;
 end
end

modes

hybrid_modes

Important

The mode must also be in modes to take effect.

linewise_hybrid_mode

ignore_previews

--- Controls which items are affected by `hybrid_mode`.
---@class preview.ignore
---
---@field vimdoc? ignore_vimdoc[]
ignore_previews = {}
---@alias ignore_vimdoc
---| "arguments"
---| "code_blocks"
---| "headings"
---| "highlight_groups"
---| "horizontal_rules"
---| "inline_codes"
---| "keycodes"
---| "modelines"
---| "notes"
---| "optionlinks"
---| "tags"
---| "taglinks"
---| "urls"
---
---| "!arguments"
---| "!code_blocks"
---| "!headings"
---| "!highlight_groups"
---| "!horizontal_rules"
---| "!inline_codes"
---| "!keycodes"
---| "!modelines"
---| "!notes"
---| "!optionlinks"
---| "!tags"
---| "!taglinks"
---| "!urls"

Tip

You can add a ! before an option name to prevent it from being affected by hybrid mode.

--- Hybrid mode will no longer affect
--- code blocks.
ignore_previews = {
 vimdoc = { "!code_blocks" }
}

debounce

Tip

You can reduce this value if you want faster updates to the preview.

max_buf_lines

draw_range

edit_range

callbacks

--- Callback functions for specific events.
---@class preview.callbacks
---
--- Called when attaching to a buffer.
---@field on_attach? fun(buf: integer, wins: integer[]): nil
--- Called when detaching from a buffer.
---@field on_detach? fun(buf: integer, wins: integer[]): nil
---
--- Called when disabling preview of a buffer.
--- Also called when opening `splitview`.
---@field on_disable? fun(buf: integer, wins: integer[]): nil
--- Called when enabling preview of a buffer.
--- Also called when disabling `splitview`.
---@field on_enable? fun(buf: integer, wins: integer[]): nil
---
--- Called when disabling hybrid mode in a buffer.
--- > Called after `on_attach` when attaching to a buffer.
--- > Called after `on_disable`.
---@field on_hybrid_disable? fun(buf: integer, wins: integer[]): nil
--- Called when enabling hybrid mode in a buffer.
--- > Called after `on_attach`(if `hybrid_mod` is disabled).
--- > Called after `on_enable`.
---@field on_hybrid_enable? fun(buf: integer, wins: integer[]): nil
---
--- Called when changing VIM-modes(only on active buffers).
---@field on_mode_change? fun(buf: integer, wins: integer[], mode: string): nil
---
--- Called before closing splitview.
---@field on_splitview_close? fun(source: integer, preview_buf: integer, preview_win: integer): nil
--- Called when opening splitview.
---@field on_splitview_open? fun(source: integer, preview_buf: integer, preview_win: integer): nil
---
--- Called when opening `:Help`(:H).
---@field on_help_open? fun(preview_buf: integer, preview_win: integer, overlay_buf: integer, overlay_win: integer): nil

splitview_winopts

overlay_winopts

preview_winopts

icon_provider

Note

You will need to install the external icon providers to use them!

--- Icon provider.
---@field icon_provider?
---| "internal" Internal icon provider.
---| "devicons" `nvim-web-devicons` as icon provider.
---| "mini" `mini.icons` as icon provider.
icon_provider = "internal",