fix: allows no rel attribute on external links in the nav #2338
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
abea commented May 2, 2020
| @@ -69,14 +69,14 @@ module.exports = { | |||
| } | |||
| ``` | |||
| | |||
| Outbound links automatically get `target="_blank" rel="noopener noreferrer"`. You can offer `target` and `rel` to customize the attributes: | |||
| Outbound links automatically get `target="_blank" rel="noopener noreferrer"`. You can offer `target` and `rel` to customize the attributes. Passing a "falsy" value to the `rel` attribute will disable that attribute for a link: | |||
There was a problem hiding this comment.
Oh, maybe I should make this clearer to say that the falsy value can't be undefined.
There was a problem hiding this comment.
IMHO, change the rule. Let user set false rather than falsy value to disable the attribute.
| Should I create an issue to update this in the Chinese docs or something? |
billyyyyy3320 requested changes May 4, 2020
I'll take it later. No worries. |
Co-authored-by: Billyyyyy3320 <newsbielt703@gmail.com>
larionov pushed a commit to larionov/vuepress that referenced this pull request Aug 19, 2020
* fix: allows no rel attribute on external links in the nav * fix: documents the falsy rel option * fix: clarifies documentation * fix: explicitly uses for rel attr * fix: removes unnecessary condition Co-authored-by: Billyyyyy3320 <newsbielt703@gmail.com> Co-authored-by: Billyyyyy3320 <newsbielt703@gmail.com>
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
Currently it's not possible to specify that there should be no
relattribute on external nav links to use the default behavior. Setting to an empty string, as indicated in the documentation, is falsy, so you end up in the final ternary, which usesnoopener noreferrerfor external links.This change allows devs to pass in a falsy, non-
undefined, value to therelproperty to have no rel attribute on the link. It also change the fallback of an empty string tonullsince an emptyrelattribute has no particular meaning, so it's better to have it not there at all.What kind of change does this PR introduce? (check at least one)
If changing the UI of default theme, please provide the before/after screenshot:
Does this PR introduce a breaking change? (check one)
If yes, please describe the impact and migration path for existing applications:
The PR fulfills these requirements:
fix #xxx[,#xxx], where "xxx" is the issue number)You have tested in the following browsers: (Providing a detailed version will be better.)
I could not tell from the contributor guide or the package scripts how to build this for linking to a project and testing. I'd be happy to do that with some direction.
If adding a new feature, the PR's description includes:
To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.
Other information: