VimSearchOverlay

Unofficial

Both Official Unofficial

Both Own Inherited

The overlay that highlights the matches of the current search query.

Import:

import type { VimSearchOverlay } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface VimSearchOverlay extends AddOverlayOptions

Extends: AddOverlayOptions

Properties

	Property	Type	Description
	query	RegExp	Regular expression pattern to highlight in the editor. (Inherited from AddOverlayOptions)

Methods

	Method	Returns	Description
	token(stream)	string | undefined	Advance the stream past the next chunk of text and name the style it should be drawn in.

---

Links to this page:

• VimSearchState