Class CodeMirrorSearchHighlighter

Helper class to highlight texts in a code mirror editor.

Highlighted texts (aka matches) must be provided through the matches attributes.

NOTES:

to retain the selection visibility drawSelection extension is needed.
highlighting starts from the cursor (if editor is focused and from is set to 'auto', cursor moved, or from argument is set to 'selection' or 'selection-start'), or from last "current" match otherwise.
currentIndex is the (readonly) source of truth for the current match.

Index

Constructors

Accessors

currentIndex matches protectSelection

Methods

clearHighlight endQuery highlightNext highlightPrevious setEditor

Constructors

constructor

new CodeMirrorSearchHighlighter(
editor: null | CodeMirrorEditor,
): CodeMirrorSearchHighlighter
Constructor
Parameters
- editor: null | CodeMirrorEditor
  The CodeMirror editor
Returns CodeMirrorSearchHighlighter
- Defined in packages/codemirror/src/searchprovider.ts:551

Accessors

currentIndex

get currentIndex(): null | number
The current index of the selected match.

Returns null | number
- Defined in packages/codemirror/src/searchprovider.ts:627

matches

get matches(): ISearchMatch[]
The list of matches

Returns ISearchMatch[]
- Defined in packages/codemirror/src/searchprovider.ts:634
set matches(v: ISearchMatch[]): void
Parameters
- v: ISearchMatch[]
Returns void
- Defined in packages/codemirror/src/searchprovider.ts:637

protectSelection

get protectSelection(): boolean
Whether the cursor/selection should not be modified.

Returns boolean
- Defined in packages/codemirror/src/searchprovider.ts:653
set protectSelection(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/codemirror/src/searchprovider.ts:656

Methods

clearHighlight

clearHighlight(): void
Clear all highlighted matches

Returns void
- Defined in packages/codemirror/src/searchprovider.ts:664

endQuery

endQuery(): Promise<void>
Clear the highlighted matches.

Returns Promise<void>
- Defined in packages/codemirror/src/searchprovider.ts:672

highlightNext

highlightNext(
options?: IHighlightAdjacentMatchOptions,
): Promise<undefined | ISearchMatch>
Highlight the next match
Parameters
- Optionaloptions: IHighlightAdjacentMatchOptions
Returns Promise<undefined | ISearchMatch>
The next match if available
- Defined in packages/codemirror/src/searchprovider.ts:690

highlightPrevious

highlightPrevious(
options?: IHighlightAdjacentMatchOptions,
): Promise<undefined | ISearchMatch>
Highlight the previous match
Parameters
- Optionaloptions: IHighlightAdjacentMatchOptions
Returns Promise<undefined | ISearchMatch>
The previous match if available
- Defined in packages/codemirror/src/searchprovider.ts:707

setEditor

setEditor(editor: CodeMirrorEditor): void
Set the editor
Parameters
- editor: CodeMirrorEditor
  Editor
Returns void
- Defined in packages/codemirror/src/searchprovider.ts:724