Add getInitialQuery to documentsearch interface #6256
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As suggested on #6081 by @gabegrand, this adds
getInitialQuery
to theISearchProvider
interface. This allows theSearchInstance
to get the initial query (set asany
because it could be any type of object in the future when we support other search widgets), populate the search box and start a search. To the user, this means that if you have a word selected and press ctrl + f, a search box will open populated with that word, all of the matches will be highlighted, and the selected match will be in yellow. This logic only activates when the search box is initially created, so it won't ever clobber existing text in the search box. Lastly, because search doesn't support newlines, if a selection contains newlines at the time of search box creation, the box will not be populated. @jasongrout