plugins.flash.modes.search

options used when flash is activated through a regular search with / or ?

Plugin default:

{
  enabled = true;
  highlight = { backdrop = false; };
  jump = { history = true; register = true; nohlsearch = true; };
  /*
    forward will be automatically set to the search direction
    mode is always set to 'search'
    incremental is set to 'true' when 'incsearch' is enabled
  */
  search.automatic = true;
}

Type: null or (submodule)

Default: null

Declared by:

plugins.flash.modes.search.enabled

when true, flash will be activated during regular search by default. You can always toggle when searching with require("flash").toggle()

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.action

action to perform when picking a label. defaults to the jumping logic depending on the mode. @type fun(match:Flash.Match, state:Flash.State)

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.flash.modes.search.config

Set config to a function to dynamically change the config @type fun(opts:Flash.Config)

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.flash.modes.search.continue

When true, flash will try to continue the last search

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.labels

Labels appear next to the matches, allowing you to quickly jump to any location. Labels are guaranteed not to exist as a continuation of the search pattern.

Plugin default: "asdfghjklqwertyuiopzxcvbnm"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.flash.modes.search.pattern

initial pattern to use when opening flash

Plugin default: ""

Type: null or string or raw lua code

Default: null

Declared by: