mirror of
https://github.com/JamesIves/github-pages-deploy-action.git
synced 2023-12-15 20:03:39 +08:00
24 lines
808 B
Markdown
24 lines
808 B
Markdown
|
# accessible-emoji
|
||
|
|
||
|
Emoji have become a common way of communicating content to the end user. To a person using a screenreader, however, he/she may not be aware that this content is there at all. By wrapping the emoji in a `<span>`, giving it the `role="img"`, and providing a useful description in `aria-label`, the screenreader will treat the emoji as an image in the accessibility tree with an accessible name for the end user.
|
||
|
|
||
|
#### Resources
|
||
|
1. [Léonie Watson](http://tink.uk/accessible-emoji/)
|
||
|
|
||
|
## Rule details
|
||
|
|
||
|
This rule takes no arguments.
|
||
|
|
||
|
### Succeed
|
||
|
```jsx
|
||
|
<span role="img" aria-label="Snowman">☃</span>
|
||
|
<span role="img" aria-label="Panda">🐼</span>
|
||
|
<span role="img" aria-labelledby="panda1">🐼</span>
|
||
|
```
|
||
|
|
||
|
### Fail
|
||
|
```jsx
|
||
|
<span>🐼</span>
|
||
|
<i role="img" aria-label="Panda">🐼</i>
|
||
|
```
|