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 1 commit
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
Prev Previous commit
Next Next commit
Add new settings for external link behavior 
These labels get combined in mixin to inform users about external links and whether they open in new tabs or not.
  • Loading branch information
James Mejia committed Apr 7, 2023
commit fe1ed871468102150afd38369ac2dea2dd4a45da
7 changes: 6 additions & 1 deletion 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
Expand Up @@ -21,7 +21,12 @@ $icon-object: (
// Screen reader label
&::before {
@include sr-only;
content: $theme-external-link-sr-label;
content: "#{$theme-external-link-sr-label}, #{$theme-external-link-sr-label-window-same}";
}

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

&::after {
Expand Down
2 changes: 2 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 @@ -125,6 +125,8 @@ $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-window-new: "opens in a new window" !default;
$theme-external-link-sr-label-window-same: "opens in current window" !default;

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