59 lines
2.3 KiB
JavaScript
59 lines
2.3 KiB
JavaScript
"use strict";
|
|
|
|
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
|
|
|
var _emojiRegex = _interopRequireDefault(require("emoji-regex"));
|
|
|
|
var _jsxAstUtils = require("jsx-ast-utils");
|
|
|
|
var _schemas = require("../util/schemas");
|
|
|
|
var _isHiddenFromScreenReader = _interopRequireDefault(require("../util/isHiddenFromScreenReader"));
|
|
|
|
/**
|
|
* @fileoverview Enforce emojis are wrapped in <span> and provide screenreader access.
|
|
* @author Ethan Cohen
|
|
*/
|
|
// ----------------------------------------------------------------------------
|
|
// Rule Definition
|
|
// ----------------------------------------------------------------------------
|
|
var errorMessage = 'Emojis should be wrapped in <span>, have role="img", and have an accessible description with aria-label or aria-labelledby.';
|
|
var schema = (0, _schemas.generateObjSchema)();
|
|
module.exports = {
|
|
meta: {
|
|
docs: {
|
|
url: 'https://github.com/evcohen/eslint-plugin-jsx-a11y/tree/master/docs/rules/accessible-emoji.md'
|
|
},
|
|
schema: [schema]
|
|
},
|
|
create: function create(context) {
|
|
return {
|
|
JSXOpeningElement: function JSXOpeningElement(node) {
|
|
var literalChildValue = node.parent.children.find(function (child) {
|
|
return child.type === 'Literal' || child.type === 'JSXText';
|
|
});
|
|
|
|
if (literalChildValue && (0, _emojiRegex["default"])().test(literalChildValue.value)) {
|
|
var elementIsHidden = (0, _isHiddenFromScreenReader["default"])((0, _jsxAstUtils.elementType)(node), node.attributes);
|
|
|
|
if (elementIsHidden) {
|
|
return; // emoji is decorative
|
|
}
|
|
|
|
var rolePropValue = (0, _jsxAstUtils.getLiteralPropValue)((0, _jsxAstUtils.getProp)(node.attributes, 'role'));
|
|
var ariaLabelProp = (0, _jsxAstUtils.getProp)(node.attributes, 'aria-label');
|
|
var arialLabelledByProp = (0, _jsxAstUtils.getProp)(node.attributes, 'aria-labelledby');
|
|
var hasLabel = ariaLabelProp !== undefined || arialLabelledByProp !== undefined;
|
|
var isSpan = (0, _jsxAstUtils.elementType)(node) === 'span';
|
|
|
|
if (hasLabel === false || rolePropValue !== 'img' || isSpan === false) {
|
|
context.report({
|
|
node,
|
|
message: errorMessage
|
|
});
|
|
}
|
|
}
|
|
}
|
|
};
|
|
}
|
|
}; |