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

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