Implement search in Settings UI #19519
Open
Conversation
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
- SearchMetadata is unsused, but it is designed to hold information
so that we can navigate to a setting
- Updated all pages to...
- have an x:Name on relevant setting containers
- have a NavigateToXArgs used in the OnNavigatedTo() function
- update the NavigateToXArgs to include the name of an element
to scroll down to
- Add BringIntoViewWhenLoaded() to HasScrollViewer<T> which
scrolls down to the element with a given name
These components aren't fully hooked up together yet and there's a
few TODO CARLOS's throughout. Main upcoming work:
- indexing
- runtime indexing
- search box UI
- search results UI
based on https://github.com/microsoft/PowerToys/blob/079c69b8beced55211485c352f41308426930e47/doc/specs/settings-search.md
- Adds referential XAML names to components of interest. - Adds a script that generates the build time entries to be loaded - Invokes the script in Editor.vcxproj
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
microsoft-github-policy-service
bot
added
Issue-Feature
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
lhecker
reviewed
Nov 7, 2025
Member
lhecker
left a comment
lhecker
left a comment
There was a problem hiding this comment.
Why do we need multiple runtimeclass NavigateTo classes? Why not use one and it has an IInspectable navigate-to argument?
src/cascadia/TerminalSettingsEditor/Resources/en-US/Resources.resw
Outdated
Show resolved
Hide resolved
This comment has been minimized.
This comment has been minimized.
Member
Author
Honestly, that's a good idea now that we need one of these for every page we navigate to. I'll add a |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
carlos-zamora
added a commit
that referenced
this pull request
Nov 18, 2025
carlos-zamora
added a commit
that referenced
this pull request
Nov 19, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary of the Pull Request
Adds search functionality to the settings UI. This is added to an
AutoSuggestBoxin the mainNavigationView. Invoking a result navigates to the proper location in the settings UI and focuses the setting, when possible.References and Relevant Issues
Based on microsoft/PowerToys#41285
Detailed Description of the Pull Request / Additional comments
x:Nameso that we can navigate to them and bring them into view.BringIntoViewWhenLoaded()which navigates to the relevant part of the UI. This is called inOnNavigatedTo()for each page.MainPage:_UpdateSearchIndex: loads the search index generated byGenerateSettingsIndex.ps1; provides additional localization, if neededSettingsSearchBox_TextChanged:_QuerySearchIndex()SettingsSearchBox_QuerySubmitted: extract the search index metadata and call the correct_Navigate()functionValidation Steps Performed
Search for...
PR Checklist
Closes #12949
Follow-ups
These are some additional features that may be added as a part of this PR or as a follow-up: