Set whether or not this will wrap to the beginning or end of the document on invocations of highlightNext or highlightPrevious, respectively
We choose opt out as most node types should be searched (e.g. script). Even nodes like , could have textContent we care about.
Note: nodeName is capitalized, so we do the same here
Signal indicating that something in the search has changed, so the UI should update
The current index of the selected match.
The same list of matches provided by the startQuery promise resolution
Clears state of a search provider to prepare for startQuery to be called in order to start a new query or refresh an existing one.
A promise that resolves when the search provider is ready to begin a new search.
Resets UI state, removes all matches.
A promise that resolves when all state has been cleaned up.
Get an initial query value if applicable so that it can be entered into the search box as an initial query
Initial value used to populate the search box.
Move the current match indicator to the next match.
A promise that resolves once the action has completed.
Move the current match indicator to the previous match.
A promise that resolves once the action has completed.
Replace all matches in the notebook with the provided text
A promise that resolves with a boolean indicating whether a replace occurred.
Replace the currently selected match with the provided text
A promise that resolves with a boolean indicating whether a replace occurred.
Initialize the search using the provided options. Should update the UI to highlight all matches and "select" whatever the first match should be.
A RegExp to be use to perform the search
The widget to be searched
A promise that resolves with a list of all matches
Report whether or not this provider has the ability to search on the given object
Generated using TypeDoc
Set 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.