85 lines
3.9 KiB
JavaScript
85 lines
3.9 KiB
JavaScript
'use strict';
|
|
|
|
var _ariaQuery = require('aria-query');
|
|
|
|
var _jsxAstUtils = require('jsx-ast-utils');
|
|
|
|
var _schemas = require('../util/schemas');
|
|
|
|
var _getImplicitRole = require('../util/getImplicitRole');
|
|
|
|
var _getImplicitRole2 = _interopRequireDefault(_getImplicitRole);
|
|
|
|
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
|
|
function _toConsumableArray(arr) { if (Array.isArray(arr)) { for (var i = 0, arr2 = Array(arr.length); i < arr.length; i++) { arr2[i] = arr[i]; } return arr2; } else { return Array.from(arr); } } /**
|
|
* @fileoverview Enforce that elements with explicit or implicit roles defined contain only
|
|
* `aria-*` properties supported by that `role`.
|
|
* @author Ethan Cohen
|
|
*/
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// Rule Definition
|
|
// ----------------------------------------------------------------------------
|
|
|
|
var errorMessage = function errorMessage(attr, role, tag, isImplicit) {
|
|
if (isImplicit) {
|
|
return 'The attribute ' + attr + ' is not supported by the role ' + role + '. This role is implicit on the element ' + tag + '.';
|
|
}
|
|
|
|
return 'The attribute ' + attr + ' is not supported by the role ' + role + '.';
|
|
};
|
|
|
|
var schema = (0, _schemas.generateObjSchema)();
|
|
|
|
module.exports = {
|
|
meta: {
|
|
docs: {
|
|
url: 'https://github.com/evcohen/eslint-plugin-jsx-a11y/tree/master/docs/rules/role-supports-aria-props.md'
|
|
},
|
|
schema: [schema]
|
|
},
|
|
|
|
create: function create(context) {
|
|
return {
|
|
JSXOpeningElement: function JSXOpeningElement(node) {
|
|
// If role is not explicitly defined, then try and get its implicit role.
|
|
var type = (0, _jsxAstUtils.elementType)(node);
|
|
var role = (0, _jsxAstUtils.getProp)(node.attributes, 'role');
|
|
var roleValue = role ? (0, _jsxAstUtils.getLiteralPropValue)(role) : (0, _getImplicitRole2.default)(type, node.attributes);
|
|
var isImplicit = roleValue && role === undefined;
|
|
|
|
// If there is no explicit or implicit role, then assume that the element
|
|
// can handle the global set of aria-* properties.
|
|
// This actually isn't true - should fix in future release.
|
|
if (typeof roleValue !== 'string' || _ariaQuery.roles.get(roleValue) === undefined) {
|
|
return;
|
|
}
|
|
|
|
// Make sure it has no aria-* properties defined outside of its property set.
|
|
|
|
var _roles$get = _ariaQuery.roles.get(roleValue),
|
|
propKeyValues = _roles$get.props;
|
|
|
|
var propertySet = Object.keys(propKeyValues);
|
|
var invalidAriaPropsForRole = [].concat(_toConsumableArray(_ariaQuery.aria.keys())).filter(function (attribute) {
|
|
return propertySet.indexOf(attribute) === -1;
|
|
});
|
|
|
|
node.attributes.forEach(function (prop) {
|
|
if (prop.type === 'JSXSpreadAttribute') {
|
|
return;
|
|
}
|
|
|
|
var name = (0, _jsxAstUtils.propName)(prop);
|
|
if (invalidAriaPropsForRole.indexOf(name) > -1) {
|
|
context.report({
|
|
node: node,
|
|
message: errorMessage(name, roleValue, type, isImplicit)
|
|
});
|
|
}
|
|
});
|
|
}
|
|
};
|
|
}
|
|
}; |