plugins.scrollview.settings

The configuration options for scrollview without the scrollview_ prefix.

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

  • foo_bar = 1 -> :setglobal scrollview_foo_bar=1
  • hello = "world" -> :setglobal scrollview_hello="world"
  • some_toggle = true -> :setglobal scrollview_some_toggle
  • other_toggle = false -> :setglobal noscrollview_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  base = "buffer";
  column = 80;
  current_only = true;
  diagnostics_severities = [
    {
      __raw = "vim.diagnostic.severity.ERROR";
    }
  ];
  excluded_filetypes = [
    "nerdtree"
  ];
  signs_on_startup = [
    "all"
  ];
}

Declared by:

plugins.scrollview.settings.always_show

Specify whether scrollbars and signs are shown when all lines are visible.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.scrollview.settings.base

Specify where the scrollbar is anchored.

Possible values are "left" or "right" for corresponding window edges, or "buffer".

Type: null or one of “right”, “left”, “buffer” or raw lua code

Default: null

Plugin default: "right"

Declared by:

plugins.scrollview.settings.byte_limit

The buffer size threshold (in bytes) for entering restricted mode, to prevent slow operation.

Use -1 for no limit.

Type: null or signed integer or floating point number or raw lua code

Default: null

Plugin default: 1000000

Declared by:

plugins.scrollview.settings.changelist_current_priority

The priority for the the current changelist sign.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: 10

Declared by:

plugins.scrollview.settings.changelist_current_symbol

The symbol for the current item changelist sign.

Type: null or string or raw lua code

Default: null

Plugin default: "@"

Declared by:

plugins.scrollview.settings.changelist_next_priority

The priority for the the next item changelist sign.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: 5

Declared by:

plugins.scrollview.settings.changelist_next_symbol

The symbol for the next item changelist sign.

Defaults to a downwards arrow with tip rightwards.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.scrollview.settings.changelist_previous_priority

The priority for the the previous item changelist sign.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: 15

Declared by:

plugins.scrollview.settings.changelist_previous_symbol

The symbol for the previous item changelist sign.

Defaults to an upwards arrow with tip leftwards.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.scrollview.settings.character

A character to display on scrollbars.

Scrollbar transparency (via |scrollview_winblend|) is not possible when a scrollbar character is used.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.scrollview.settings.column

The scrollbar column (relative to |scrollview_base|).

Must be an integer greater than or equal to 1.

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

Default: null

Plugin default: 1

Declared by:

plugins.scrollview.settings.conflicts_bottom_priority

The priority for the conflict bottom signs.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: 80

Declared by:

plugins.scrollview.settings.conflicts_bottom_symbol

The symbol for conflict bottom signs.

A list of strings can also be used; the symbol is selected using the index equal to the number of lines corresponding to the sign, or the last element when the retrieval would be out-of-bounds.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: ">"

Declared by:

plugins.scrollview.settings.conflicts_middle_priority

The priority for the conflict middle signs.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: 75

Declared by:

plugins.scrollview.settings.conflicts_middle_symbol

The symbol for conflict middle signs.

A list of strings can also be used; the symbol is selected using the index equal to the number of lines corresponding to the sign, or the last element when the retrieval would be out-of-bounds.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: "="

Declared by:

plugins.scrollview.settings.conflicts_top_priority

The priority for the conflict top signs.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: 70

Declared by:

plugins.scrollview.settings.conflicts_top_symbol

The symbol for conflict top signs.

A list of strings can also be used; the symbol is selected using the index equal to the number of lines corresponding to the sign, or the last element when the retrieval would be out-of-bounds.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: "<"

Declared by:

plugins.scrollview.settings.consider_border

(experimental)

Specify whether floating window borders are taken into account for positioning scrollbars and signs.

  • When set to true, borders are considered as part of the window; scrollbars and signs can be positioned where there are borders.
  • When set to false, borders are ignored.

The setting is only applicable for floating windows that have borders, and only relevant when floating_windows is turned on and base is set to "left" or "right".

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.scrollview.settings.current_only

Whether scrollbars and signs should only be displayed in the current window.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.scrollview.settings.cursor_priority

The priority for the cursor signs.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: 0

Declared by:

plugins.scrollview.settings.cursor_symbol

The symbol for cursor signs.

Defaults to a small square, resembling a block cursor.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.scrollview.settings.diagnostics_error_priority

The priority for the cursor diagnostic error signs.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: 60

Declared by:

plugins.scrollview.settings.diagnostics_error_symbol

The symbol for diagnostic error signs.

Defaults to the trimmed sign text for DiagnosticSignError if defined, or "E" otherwise.

A list of strings can also be used; the symbol is selected using the index equal to the number of lines corresponding to the sign, or the last element when the retrieval would be out-of-bounds.

Considered only when the plugin is loaded.

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

Default: null

Declared by:

plugins.scrollview.settings.diagnostics_hint_priority

The priority for the the diagnostic hint signs.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: 30

Declared by:

plugins.scrollview.settings.diagnostics_hint_symbol

The symbol for diagnostic hint signs.

Defaults to the trimmed sign text for DiagnosticSignHint if defined, or "H" otherwise.

A list of strings can also be used; the symbol is selected using the index equal to the number of lines corresponding to the sign, or the last element when the retrieval would be out-of-bounds.

Considered only when the plugin is loaded.

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

Default: null

Declared by:

plugins.scrollview.settings.diagnostics_info_priority

The priority for the the diagnostic info signs.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: 40

Declared by:

plugins.scrollview.settings.diagnostics_info_symbol

The symbol for diagnostic info signs.

Defaults to the trimmed sign text for DiagnosticSignInfo if defined, or "I" otherwise.

A list of strings can also be used; the symbol is selected using the index equal to the number of lines corresponding to the sign, or the last element when the retrieval would be out-of-bounds.

Considered only when the plugin is loaded.

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

Default: null

Declared by:

plugins.scrollview.settings.diagnostics_severities

List of numbers specifying the diagnostic severities for which signs will be shown. The default includes vim.diagnostic.severity.ERROR, vim.diagnostic.severity.HINT, "vim.diagnostic.severity.INFO", and vim.diagnostic.severity.WARN.

Considered only when the plugin is loaded.

Type: null or unsigned integer, meaning >=0, or (list of (unsigned integer, meaning >=0, or raw lua code)) or raw lua code

Default: null

Declared by:

plugins.scrollview.settings.diagnostics_warn_priority

The priority for the the diagnostic warn signs.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: 50

Declared by:

plugins.scrollview.settings.diagnostics_warn_symbol

The symbol for diagnostic warn signs.

Defaults to the trimmed sign text for DiagnosticSignWarn if defined, or "W" otherwise.

A list of strings can also be used; the symbol is selected using the index equal to the number of lines corresponding to the sign, or the last element when the retrieval would be out-of-bounds.

Considered only when the plugin is loaded.

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

Default: null

Declared by:

plugins.scrollview.settings.excluded_filetypes

optional file types for which scrollbars should not be displayed.

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

Default: null

Plugin default: [ ]

Declared by:

plugins.scrollview.settings.floating_windows

Whether scrollbars and signs are shown in floating windows.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.scrollview.settings.folds_priority

The priority for the fold signs.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: 30

Declared by:

plugins.scrollview.settings.folds_symbol

The symbol for fold signs.

Defaults to a right-pointing triangle.

A list of strings can also be used; the symbol is selected using the index equal to the number of lines corresponding to the sign, or the last element when the retrieval would be out-of-bounds.

Considered only when the plugin is loaded.

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

Default: null

Declared by:

plugins.scrollview.settings.hide_bar_for_insert

Whether the scrollbar is hidden in the current window for insert mode.

See the signs_hidden_for_insert option for hiding signs.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.scrollview.settings.hide_on_intersect

Whether each scrollbar or sign becomes hidden (not shown) when it would otherwise intersect with a floating window.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.scrollview.settings.hover

Whether the highlighting of scrollbars and signs should change when hovering with the mouse. Requires mouse support (see |'mouse'|) with |'mousemoveevent'| set.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.scrollview.settings.include_end_region

Whether the region beyond the last line is considered as containing ordinary lines for the calculation of scrollbar height and positioning.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.scrollview.settings.latestchange_priority

The priority for the latestchange signs.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: 10

Declared by:

plugins.scrollview.settings.latestchange_symbol

The symbol for latestchange signs.

Defaults to a Greek uppercase delta.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.scrollview.settings.line_limit

The buffer size threshold (in lines) for entering restricted mode, to prevent slow operation. Defaults to 20000. Use -1 for no limit.

Type: null or signed integer or floating point number or raw lua code

Default: null

Plugin default: -1

Declared by:

plugins.scrollview.settings.loclist_priority

The priority for the loclist signs.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: 45

Declared by:

plugins.scrollview.settings.loclist_symbol

The symbol for loclist signs.

Defaults to a small circle.

A list of strings can also be used; the symbol is selected using the index equal to the number of lines corresponding to the sign, or the last element when the retrieval would be out-of-bounds.

Considered only when the plugin is loaded.

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

Default: null

Declared by:

plugins.scrollview.settings.marks_characters

List of strings specifying characters for which mark signs will be shown. Defaults to characters a-z and A-Z.

Considered only when the plugin is loaded.

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

Default: null

Declared by:

plugins.scrollview.settings.marks_priority

The priority for the mark signs.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: 50

Declared by:

plugins.scrollview.settings.mode

Specify what the scrollbar position and size correspond to. See |scrollview-modes| for details on the available modes.

Type: null or string or raw lua code

Default: null

Plugin default: "auto"

Declared by:

plugins.scrollview.settings.mouse_primary

The button for primary mouse operations (dragging scrollbars and clicking signs).

Possible values include "left", "middle", "right", "x1", and "x2". These can be prepended with "c-" or "m-" for the control-key and alt-key variants (e.g., "c-left" for control-left).

An existing mapping will not be clobbered, unless "!" is added at the end (e.g., "left!"). Set to "nil" to disable the functionality.

Considered only when the plugin is loaded.

Type: null or string or raw lua code

Default: null

Plugin default: "left"

Declared by:

plugins.scrollview.settings.mouse_secondary

The button for secondary mouse operations (clicking signs for additional information).

See the mouse_primary option for the possible values, including how "c-", "m-", "!", and "nil" can be utilized.

Considered only when the plugin is loaded.

Type: null or string or raw lua code

Default: null

Plugin default: "right"

Declared by:

plugins.scrollview.settings.on_startup

Whether scrollbars are enabled on startup.

Considered only when the plugin is loaded.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.scrollview.settings.quickfix_priority

The priority for the quickfix signs.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: 45

Declared by:

plugins.scrollview.settings.quickfix_symbol

The symbol for quickfix signs.

Defaults to a small circle.

A list of strings can also be used; the symbol is selected using the index equal to the number of lines corresponding to the sign, or the last element when the retrieval would be out-of-bounds.

Considered only when the plugin is loaded.

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

Default: null

Declared by:

plugins.scrollview.settings.search_priority

The priority for the search signs.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: 70

Declared by:

plugins.scrollview.settings.search_symbol

The symbol for search signs.

Defaults to ["=" "=" {__raw = "vim.fn.nr2char(0x2261)";}] where the third element is the triple bar.

A list of strings can also be used; the symbol is selected using the index equal to the number of lines corresponding to the sign, or the last element when the retrieval would be out-of-bounds.

Considered only when the plugin is loaded.

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

Default: null

Declared by:

plugins.scrollview.settings.signs_hidden_for_insert

The sign groups to hide in the current window for insert mode. Set to [ "all" ] to hide all sign groups.

See |scrollview_hide_bar_for_insert| for hiding the scrollbar.

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

Default: null

Plugin default: [ ]

Declared by:

plugins.scrollview.settings.signs_max_per_row

The maximum number of signs per row. Set to -1 to have no limit.

Type: null or signed integer or floating point number or raw lua code

Default: null

Plugin default: -1

Declared by:

plugins.scrollview.settings.signs_on_startup

The built-in sign groups to enable on startup. Set to {__empty = null;} to disable all built-in sign groups on startup. Set to ['all'] to enable all sign groups. Considered only when the plugin is loaded.

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

Default: null

Plugin default:

[
  "diagnostics"
  "marks"
  "search"
]

Declared by:

plugins.scrollview.settings.signs_overflow

The sign overflow direction (to avoid overlapping the scrollbar or other signs).

Type: null or one of “left”, “right” or raw lua code

Default: null

Plugin default: "left"

Declared by:

plugins.scrollview.settings.signs_show_in_folds

Whether signs on lines within hidden folds should be shown. Sign groups can override this setting (e.g., the built-in cursor sign group does).

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.scrollview.settings.spell_priority

The priority for the spell signs.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: 20

Declared by:

plugins.scrollview.settings.spell_symbol

The symbol for spell signs.

A list of strings can also be used; the symbol is selected using the index equal to the number of lines corresponding to the sign, or the last element when the retrieval would be out-of-bounds.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: "~"

Declared by:

plugins.scrollview.settings.textwidth_priority

The priority for the textwidth signs.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: 20

Declared by:

plugins.scrollview.settings.textwidth_symbol

The symbol for textwidth signs.

Defaults to a right-pointing double angle quotation mark.

A list of strings can also be used; the symbol is selected using the index equal to the number of lines corresponding to the sign, or the last element when the retrieval would be out-of-bounds.

Considered only when the plugin is loaded.

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

Default: null

Declared by:

plugins.scrollview.settings.trail_priority

The priority for the trail signs.

Considered only when the plugin is loaded.

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

Default: null

Plugin default: 50

Declared by:

plugins.scrollview.settings.trail_symbol

The symbol for trail signs.

Defaults to an outlined square.

A list of strings can also be used; the symbol is selected using the index equal to the number of lines corresponding to the sign, or the last element when the retrieval would be out-of-bounds.

Considered only when the plugin is loaded.

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

Default: null

Declared by:

plugins.scrollview.settings.winblend

The level of transparency for scrollbars when a GUI is not running and termguicolors is not set.

Must be between 0 (opaque) and 100 (transparent).

This option is ignored for scrollview windows whose highlight group has reverse or inverse specified as a cterm attribute; see |attr-list|. Such windows will have no transparency, as a workaround for Neovim #24159.

This option is ignored for scrollview windows shown for floating windows; see |scrollview_floating_windows|. Such windows will have no transparency, as a workaround for Neovim #14624.

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

Default: null

Plugin default: 50

Declared by:

plugins.scrollview.settings.winblend_gui

(experimental)

The level of transparency for scrollbars when a GUI is running or termguicolors is set.

Must be between 0 (opaque) and 100 (transparent).

This option is ignored for scrollview windows whose highlight group has reverse or inverse specified as a gui attribute; see |attr-list|. Such windows will have no transparency, as a workaround for Neovim #24159.

This option is ignored for scrollview windows shown for floating windows; see |scrollview_floating_windows|. Such windows will have no transparency, as a workaround for Neovim #14624.

This option can interact with highlight settings (|scrollview-color-customization|); careful adjustment of the winblend setting and highlighting may be necessary to achieve the desired result.

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

Default: null

Plugin default: 0

Declared by:

plugins.scrollview.settings.zindex

The z-index for scrollbars and signs. Must be larger than zero.

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

Default: null

Plugin default: 40

Declared by: