Skip to content

fix(docs): Icon examples aria labels added #15013 #15145

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.

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 2 commits into from
Feb 22, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<mat-icon>home</mat-icon>
<mat-icon aria-hidden="false" aria-label="Example home icon">home</mat-icon>
Copy link
Member

Choose a reason for hiding this comment

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

I believe that the right thing here is to still keep it as aria-hidden. cc @jelbourn

Copy link
Member

Choose a reason for hiding this comment

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

This one is somewhat tricky. The icon by itself doesn't actually mean anything since it's just an example. The two options would be to do this (hidden="false" with a label), or to add a separate visibly-hidden span that describes the example.

I think this PR is probably fine as is- it's at least better than what it was before.

2 changes: 1 addition & 1 deletion src/material-examples/icon-svg/icon-svg-example.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<mat-icon svgIcon="thumbs-up"></mat-icon>
<mat-icon svgIcon="thumbs-up" aria-hidden="false" aria-label="Example thumbs up SVG icon"></mat-icon>