Skip to content

Commit 0085733

Browse files
authored
Merge pull request #301 from vue-a11y/deprecate-a11y-emoji
Deprecate a11y emoji
2 parents e224dfd + a574f9b commit 0085733

File tree

3 files changed

+6
-1
lines changed

3 files changed

+6
-1
lines changed

CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
66

77
## [Unreleased]
88

9+
### Changed
10+
11+
- Deprecate the accessible-emoji rule. See https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/issues/627 for details.
12+
913
## [1.1.0] - 2021-10-14
1014

1115
### Added

docs/accessible-emoji.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# accessible-emoji
1+
# [Deprecated] accessible-emoji
22

33
Emojis 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.
44

src/rules/accessible-emoji.ts

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ const rule: Rule.RuleModule = {
1515
docs: {
1616
url: makeDocsURL("accessible-emoji")
1717
},
18+
deprecated: true,
1819
messages: {
1920
default: `Emojis should be wrapped in <span>, have role="img", and have an accessible description with aria-label or aria-labelledby.`
2021
}

0 commit comments

Comments
 (0)