plugins.vim-matchup.settings.matchparen_offscreen

Attrs controlling the behavior with off-screen matches. If empty, this feature is disabled.

Type: null or (attribute set of anything)

Default: null

Plugin default:

{
  method = "status";
}

Example:

{
  __empty = null;
}

Declared by:

plugins.vim-matchup.settings.matchparen_offscreen.border

For floating window on neovim only: set to add a border. If the value is the integer 1, default borders are enabled.

A list or string can be specified as described in |nvim_open_win()|.

Type: null or (one of 0, 1) or list of string

Default: null

Plugin default: 0

Declared by:

plugins.vim-matchup.settings.matchparen_offscreen.fullwidth

For "popup" method: make the floating window as wide as the current window.

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 0

Declared by:

plugins.vim-matchup.settings.matchparen_offscreen.highlight

For popup method on vim only: set to a highlight group to override the colors in the popup window. The default is to use *hl-Pmenu*.

Type: null or string or raw lua code

Default: null

Example: "OffscreenPopup"

Declared by:

plugins.vim-matchup.settings.matchparen_offscreen.method

Sets the method to use to show off-screen matches. Possible values are:

  • "status" (default): Replace the |status-line| for off-screen matches.
    If a match is off of the screen, the line belonging to that match will be displayed syntax-highlighted in the status line along with the line number (if line numbers are enabled). If the match is above the screen border, an additional Δ symbol will be shown to indicate that the matching line is really above the cursor line.
  • "status_manual": Compute the string which would be displayed in the status-line or popup, but do not display it. The function MatchupStatusOffscreen() can be used to get the text.
  • "popup": Use a floating window to show the off-screen match.

Type: null or one of “status”, “status_manual”, “popup”

Default: null

Plugin default: "status"

Example: "popup"

Declared by:

plugins.vim-matchup.settings.matchparen_offscreen.scrolloff

When enabled, off-screen matches will not be shown in the statusline while the cursor is at the screen edge (respects the value of 'scrolloff').

This is intended to prevent flickering while scrolling with j and k.

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 0

Declared by:

plugins.vim-matchup.settings.matchparen_offscreen.syntax_hl

For popup method on vim only: syntax highlight the code in the popup. May have performance implications.

Type: null or (one of 0, 1) or raw lua code

Default: null

Plugin default: 0

Declared by: