[docs-infra] Fix broken anchor button when header has a link #43598
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
Netlify deploy previewhttps://deploy-preview-43598--material-ui.netlify.app/ Bundle size report |
| headingHtml.includes('<a ') | ||
| ? [ | ||
| // Avoid breaking the anchor link button | ||
| `<h${level} id="${hash}"><a href="#${hash}" class="title-link-to-anchor">${headingHtml}</a>`, |
There was a problem hiding this comment.
Did you test this modification on MUI X?
This might work, but still create weird HTML with nested <a/> elements
If the title contains a link the code
<a>${headingHtml}</a><a><span><svg>...</svg></span></a>
will return
<a>
Main title
<a>Pro component</a>
</a>
<a>
<span><svg>...</svg></span>
</a>There was a problem hiding this comment.
Yes, technically, the nested <a> tag is not valid and browsers try to "fix" it, which causes the issue this PR aims to fix.
This PR doesn't fix the nested <a> tag problem but ensures the anchor button works.
There was a problem hiding this comment.
Regarding testing, I used this page to verify it works: https://deploy-preview-43598--material-ui.netlify.app/experiments/docs/headers/
alexfauquette
approved these changes
Sep 5, 2024
Michael-Hutchinson
pushed a commit
to Michael-Hutchinson/material-ui
that referenced
this pull request
Sep 7, 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.
In MUI X, we often have links in the header marking the Plan.
It turns out, the anchor button doesn't work if the header contains a link – see https://deploy-preview-14443--material-ui-x.netlify.app/x/react-data-grid/#commercial-licenses
This PR fixes the issue.