feat: allow activeBaseRegex for DocNavbarItem #8079
+33
−5
Conversation
This file contains 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
juliusmarminge
requested review from
slorber,
lex111 and
Josh-Cena
as code owners
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site settings. |
juliusmarminge
commented
Sep 10, 2022
Comment on lines
+433
to
+445
| { | ||
| type: 'doc', | ||
| position: 'left', | ||
| docId: 'playground', | ||
| label: 'Playground', | ||
| activeBaseRegex: `/docs/playground`, | ||
| }, | ||
| { | ||
| type: 'doc', | ||
| position: 'left', | ||
| docId: 'playground', | ||
| label: 'Playground', | ||
| }, |
There was a problem hiding this comment.
As you can see, the 2nd Playground link is active matched no matter what doc page we're at, whereas the first one is only matched when we are at docs/playground.
⚡️ Lighthouse report for the deploy preview of this PR
|
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site settings. |
7 tasks
3 tasks
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.
Pre-flight checklist
Motivation
DocNavbarItem's currently aren't allowed being matched using
activeBasePathoractiveBaseRegexlike other NavbarItems. This PR adds the ability to match these too.For reference, on the tRPC website, we have multiple DocItems in the navbar, and currently they are all being matched as active. By allowing them to be regex matched we would have more flexibility and could fix this issue.
Test Plan
I don't think there is any need for tests. I have reused the same logic from
NavbarNavLink. If you disagree, let me know and we can work it out.Test links
Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/
Related issues/PRs
Closes #8018