no-interactive-element-to-noninteractive-role.js 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. "use strict";
  2. var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
  3. Object.defineProperty(exports, "__esModule", {
  4. value: true
  5. });
  6. exports["default"] = void 0;
  7. var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
  8. var _ariaQuery = require("aria-query");
  9. var _jsxAstUtils = require("jsx-ast-utils");
  10. var _arrayIncludes = _interopRequireDefault(require("array-includes"));
  11. var _has = _interopRequireDefault(require("has"));
  12. var _getElementType = _interopRequireDefault(require("../util/getElementType"));
  13. var _isInteractiveElement = _interopRequireDefault(require("../util/isInteractiveElement"));
  14. var _isNonInteractiveRole = _interopRequireDefault(require("../util/isNonInteractiveRole"));
  15. var _isPresentationRole = _interopRequireDefault(require("../util/isPresentationRole"));
  16. /**
  17. * @fileoverview Disallow inherently interactive elements to be assigned
  18. * non-interactive roles.
  19. * @author Jesse Beach
  20. *
  21. */
  22. // ----------------------------------------------------------------------------
  23. // Rule Definition
  24. // ----------------------------------------------------------------------------
  25. var errorMessage = 'Interactive elements should not be assigned non-interactive roles.';
  26. var domElements = (0, _toConsumableArray2["default"])(_ariaQuery.dom.keys());
  27. var _default = {
  28. meta: {
  29. docs: {
  30. url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-interactive-element-to-noninteractive-role.md',
  31. description: 'Interactive elements should not be assigned non-interactive roles.',
  32. errorOptions: true
  33. },
  34. schema: [{
  35. type: 'object',
  36. additionalProperties: {
  37. type: 'array',
  38. items: {
  39. type: 'string'
  40. },
  41. uniqueItems: true
  42. }
  43. }]
  44. },
  45. create: function create(context) {
  46. var options = context.options;
  47. var elementType = (0, _getElementType["default"])(context);
  48. return {
  49. JSXAttribute: function JSXAttribute(attribute) {
  50. var attributeName = (0, _jsxAstUtils.propName)(attribute); // $FlowFixMe: [TODO] Mark propName as a JSXIdentifier, not a string.
  51. if (attributeName !== 'role') {
  52. return;
  53. }
  54. var node = attribute.parent;
  55. var attributes = node.attributes;
  56. var type = elementType(node);
  57. var role = (0, _jsxAstUtils.getLiteralPropValue)((0, _jsxAstUtils.getProp)(node.attributes, 'role'));
  58. if (!(0, _arrayIncludes["default"])(domElements, type)) {
  59. // Do not test higher level JSX components, as we do not know what
  60. // low-level DOM element this maps to.
  61. return;
  62. } // Allow overrides from rule configuration for specific elements and
  63. // roles.
  64. var allowedRoles = options[0] || {};
  65. if ((0, _has["default"])(allowedRoles, type) && (0, _arrayIncludes["default"])(allowedRoles[type], role)) {
  66. return;
  67. }
  68. if ((0, _isInteractiveElement["default"])(type, attributes) && ((0, _isNonInteractiveRole["default"])(type, attributes) || (0, _isPresentationRole["default"])(type, attributes))) {
  69. // Visible, non-interactive elements should not have an interactive handler.
  70. context.report({
  71. node: attribute,
  72. message: errorMessage
  73. });
  74. }
  75. }
  76. };
  77. }
  78. };
  79. exports["default"] = _default;
  80. module.exports = exports.default;