fix(core): revert wrong anchor link implementation change #10311
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
slorber
added
pr: bug fix
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
|
Size Change: -58.8 kB (-0.54%) Total Size: 10.9 MB
ℹ️ View Unchanged
|
cmdcolin
added a commit
to GMOD/jbrowse-components
that referenced
this pull request
Jul 23, 2024
…or pending fix
This was referenced Aug 12, 2024
This was referenced Aug 30, 2024
Closed
This was referenced Sep 28, 2024
This was referenced Sep 29, 2024
Closed
This was referenced Oct 4, 2024
This was referenced Oct 19, 2024
Open
Open
This was referenced Oct 20, 2024
Merged
This was referenced Nov 10, 2024
This was referenced Nov 11, 2024
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.
Motivation
Revert anchor link change from #9859
Anchors should use regular
<a>tag and not React Router links, like it used to be. Using React Router would "resolve" the anchors and add a/pathname#anchorinstead of just#anchor.I don't remember why I did that change in the first place. It is not wrong but produces unwanted bugs in community packages (see gabrielcsapo/docusaurus-plugin-search-local#82 (comment))
Edit: I remember now why I made the chang. The new v3.4 hash router can't use a regular
<a href="#anchor">tag because the target page is not#anchorbut/#/pathname#anchor: we need to use React Router link in this case.However, I still think it's useful to revert partially this change for the "browser" router because anchor links will be simpler, closer to what the
<Link>user provided as props, and produce a smaller HTML output.Took the opportunity to write some basic unit tests because our link component is quite fragile and uncovered.
Test Plan
CI + preview + check hash routing deployment anchors still work
Test links
Deploy preview: https://deploy-preview-10311--docusaurus-2.netlify.app/
Hash Router artifacts: https://github.com/facebook/docusaurus/actions/workflows/build-hash-router.yml?query=branch%3Aslorber%2Frevert-anchor-link-impl-change
Related issues/PRs
fix #10307
gabrielcsapo/docusaurus-plugin-search-local#82 (comment)