Skip to content

USWDS - Links: External link labels #5166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
May 10, 2023
Merged

USWDS - Links: External link labels #5166

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
e56e0b3
Create tests for screen reader
Mar 1, 2023
20f3afa
Remove label copy test for screen readers
Mar 6, 2023
917b3e9
Use "External link" as default screen reader label
Mar 6, 2023
1d4f007
Run prettier SCSS
Mar 6, 2023
801b913
Merge branch 'develop' of github.com:uswds/uswds into jm-external-lin…
Mar 6, 2023
5cad4bf
Add external link in new tab, update copy
Apr 7, 2023
fe1ed87
Add new settings for external link behavior
Apr 7, 2023
eb5400e
Add emphasis to current and new labels
Apr 7, 2023
8e23349
Fix formatting, add period
Apr 7, 2023
30b4e6f
Change window to tab for more accurate label
Apr 7, 2023
a07b6b6
Update variable name in mixin
Apr 7, 2023
e348c59
Remove extraneous rel property
Apr 10, 2023
fae1ed3
Add noreferrer to all external links
Apr 10, 2023
94d4274
Simplify external link language
Apr 11, 2023
a00a4ed
Added a missing "the" to a sentence in the twig template
amyleadem Apr 12, 2023
7d4d554
Update packages/uswds-core/src/styles/settings/_settings-components.scss
May 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion packages/usa-link/src/usa-link.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@

<p>This is <a class="usa-link usa-color-text-visited" href="javascript:void(0);">a visited link</a>.</p>

<p>This is a link that goes to an <a class="usa-link usa-link--external" href="https://i.giphy.com/media/WPzQF6ruiIIVzHNlwX/source.gif">external website</a>.</p>
<p>
This is a link that opens in <em>current</em> tab and goes to an <a class="usa-link usa-link--external" href="https://i.giphy.com/media/WPzQF6ruiIIVzHNlwX/source.gif">external website</a>.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No action needed, just noting that opening source.gif is still a surprise every time

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that @amyleadem mentions it yes, it does say "link" twice (which is tricky to discern since some of the links say "link" in them.

Additionally, I hear JAWS trying to say the word "tab" which runs into the phrase "external website" both in ANDI and in JAWS. I'm attaching how it looks in ANDI so you can get an idea of how it sounds. Like a run-on sentence.

external link text

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@amycole501 @amyleadem I've added the following changes:

  • Simplified the CSS
  • Removed the base variable $theme-external-link-sr-label.
  • Added punctuation to the label ex: "External, opens in a new tab." to prevent screen readers from jumbling the words together.

</p>

<p>
This is a link that opens in a <em>new</em> tab and goes to an <a class="usa-link usa-link--external" rel="noreferrer noopener" target="_blank" href="https://i.giphy.com/media/WPzQF6ruiIIVzHNlwX/source.gif">external website</a>.
Copy link
Contributor Author

@mejiaj mejiaj Apr 7, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've explicitly added rel="noreferrer noopener" as a best practice; even though most modern browsers implicitly add it.

image
MDN Browser compatibility →

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is a best practice, would it be beneficial to include guidance on noreferrer noopener in the documentation?

Copy link
Contributor Author

@mejiaj mejiaj Apr 10, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've kept noreferrer since only one is needed in [e348c59], but it might not be needed at all since modern browsers add it implicitly.

Either way, I've added it in guidance on site:
uswds/uswds-site#2056

</p>

<div class="usa-dark-background padding-1 display-inline-block">
<p>This is <a class="usa-link" href="javascript:void(0);">a text link on a dark background</a>.</p>
Expand Down
13 changes: 13 additions & 0 deletions packages/uswds-core/src/styles/mixins/general/external-link.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
@use "../../settings" as *;
@use "./icon" as *;
@use "../../functions" as *;
@use "./screen-reader" as *;

$external-link-size: 1.75ex;

Expand All @@ -16,6 +18,17 @@ $icon-object: (
@mixin external-link($contrast-bg: "default") {
display: inline;

// Screen reader label
&::before {
@include sr-only;
content: "#{$theme-external-link-sr-label}, #{$theme-external-link-sr-label-tab-same}";
}

&[target="_blank"]::before {
@include sr-only;
content: "#{$theme-external-link-sr-label}, #{$theme-external-link-sr-label-tab-new}";
}

&::after {
@include add-color-icon($icon-object, $contrast-bg);
content: "";
Expand Down
5 changes: 5 additions & 0 deletions packages/uswds-core/src/styles/settings/_settings-components.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,11 @@ $theme-in-page-nav-margin-left: 4 !default;
$theme-in-page-nav-margin-top: 2.5 !default;
$theme-in-page-nav-top: 4 !default;

// Link
$theme-external-link-sr-label: "External link" !default;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No action is required on this, but wondering if we can reduce some audio redundancy by removing the word “link” here so that it is just “External”. In Voiceover, that would mean the readout is “link, external, opens in a new tab [link text]”. I am not sure if other screen readers announce “link” in the same order though, so this might just reflect a VoiceOver bias.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@amycole501 did you notice this issue on NVDA/JAWS? If so, I can shorten it to just "External".

$theme-external-link-sr-label-tab-new: "opens in a new tab" !default;
$theme-external-link-sr-label-tab-same: "opens in current tab" !default;

// Modal
$theme-modal-border-radius: "lg" !default;
$theme-modal-default-max-width: "mobile-lg" !default;
Expand Down