the-forest/client/node_modules/eslint-plugin-jsx-a11y/docs/rules/accessible-emoji.md
2024-09-17 20:35:18 -04:00

1014 B

jsx-a11y/accessible-emoji

This rule is deprecated.

Emoji have become a common way of communicating content to the end user. To a person using a screenreader, however, they 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.

Rule details

This rule takes no arguments.

Succeed

<span role="img" aria-label="Snowman">&#9731;</span>
<span role="img" aria-label="Panda">🐼</span>
<span role="img" aria-labelledby="panda1">🐼</span>

Fail

<span>🐼</span>
<i role="img" aria-label="Panda">🐼</i>

Accessibility guidelines

Resources