Readonly currentThe current index of the selected match.
Optional filtersSignal emitted when filter definition changed.
Readonly isReadonly isSet to true if the widget under search is read-only, false if it is editable. Will be used to determine whether to show the replace option.
Readonly matchesThe number of matches.
Optional Readonly replaceSpecifies which replace options are supported by provider.
Readonly stateSignal indicating that something in the search has changed, so the UI should update
Dispose of the resources held by the object.
If the object's dispose method is called more than once, all
calls made after the first will be a no-op.
It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.
Optional getOptional getIs there one or more objects selected?
The selection can be made of one or more lines, notebook cells, or other objects (e.g. spreadsheet cells). The provider can decide whether it counts multiple characters (as opposed to lines) as multiple selection or not, which will influence the heuristic auto-enabling "search in selection" mode.
Highlight the next match
Optional loop: booleanWhether to loop within the matches list.
The next match if it exists
Highlight the previous match
Optional loop: booleanWhether to loop within the matches list.
The previous match if it exists.
Replace all matches in the widget with the provided text
The replacement text.
Optional options: IReplaceOptionsA promise that resolves with a boolean indicating whether a replace occurred.
Replace the currently selected match with the provided text and highlight the next match.
The replacement text
Optional loop: booleanWhether to loop within the matches list.
Optional options: IReplaceOptionsA promise that resolves with a boolean indicating whether a replace occurred.
Optional validateGenerated using TypeDoc
Search provider interface