Implement page search URL + Opensearch XML#2143
Open
ian-h-chamberlain wants to merge 2 commits intonushell:mainfrom
Open
Implement page search URL + Opensearch XML#2143ian-h-chamberlain wants to merge 2 commits intonushell:mainfrom
ian-h-chamberlain wants to merge 2 commits intonushell:mainfrom
Conversation
There are two pieces to this: - Prefill and execute search when a page loads with the `search` param set - Update the URL bar when a search is executed, with 500ms debounce
Also fixup some TS lint errors in the new component, language server wasn't working before.
Contributor
|
sounds cool! |
hustcer
reviewed
Mar 31, 2026
| function handleSearchInput(event: InputEvent) { | ||
| const target = event.target as HTMLInputElement | undefined; | ||
| const searchQuery = target?.value; | ||
| if (target?.id !== 'docsearch-input' || !searchQuery) { |
Contributor
There was a problem hiding this comment.
I think If the input value is empty it's better to delete the search param here. Returning early when the input is cleared means the existing ?search= parameter is not removed. As a result, after the user clears the search and closes the modal, the URL may still retains the old query.
Author
There was a problem hiding this comment.
Hmm, good point, I think that probably makes sense. I'm not sure how easy it will be to detect the modal being dismissed (since that logic is implemented in a nested child), but it's probably doable with some kind of global event listener at least.
I will try to get to implementing this next week when I should have some time!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Closes #1093
I tend to create a lot of shortcuts to doc searches in my browser, so I wanted the same thing for Nushell! I decided to take a crack at implementing the search URL logic I've seen used by many other docs websites.
Screen.Recording.2026-03-28.at.01.25.37.mov
Also set up Opensearch XML so some browsers can more easily add a search engine:
Implementation
DocSearchcomponent provided by thedocsearchPlugin, and override its registration with our custom componentIn the new
URLDocSearchcomponent:Prefill and execute search when a page loads with the
searchparam set, atonMountedAdd an
inputevent handler, which updates the URL bar when the search bar is updated. Use a 500ms debounce to avoid flooding the user's browser history with partial searches