[GSoC] Quick navigation algorithm #372
Merged
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
…tion * Introduced a new component "QuickNavigationModal" that serves as UI for the new searching functionality. * New regex pattern to match symbol titles by fuzzy and string match. * Data store to control the Quick navigation modal from anywhere on the app without having to pass the data through multiple child compoents. This change is under the quickNavigation feature flag.
…rance of a character
…fiaromorales/swift-docc-render into sr/quick-navigation/algorithm
marinaaisa
requested changes
Jul 1, 2022
* Refactor of match highlighter for Safari support using `QuickNavigationHighlighter` component * Code quality improvements suggested on pr review
|
Thanks for the review Marina! I addressed all the requested changes :) |
marinaaisa
requested changes
Jul 5, 2022
marinaaisa
approved these changes
Jul 12, 2022
There was a problem hiding this comment.
Thanks for addressing the feedback, @sofiaromorales .
It looks very very good! Congrats on the great work 👏
|
@marinaaisa there's anything else needed to merge this pr? |
|
@swift-ci test |
|
Requesting @franklinsch final look at 😄 but it looks great to me! |
|
@sofiaromorales the demo you showed me looked great! If we're happy with the code, this is good to merge (with the feature flag off by default) |
|
@swift-ci test |
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.
Bug/issue #, if applicable: NA
Summary
Algorithm and basic Vue components for the new Quick navigation feature. Changes introduced under the
quickNavigationflag.QuickNavigationModalcomponentThis pr intends to have the algorithm and base components structure for the Quick navigation feature, any other change related to the UI is for testing purposes and will be refactored in upcoming pull requests :)
First pr as part of my GSoC project mentored by @marinaaisa @franklinsch and @ bea
Dependencies
NA
Testing
Steps:
quickNavigation.enableflag to true insidetheme-settings.jsonChecklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
npm test, and it succeeded