no-noninteractive-element-interactions.js 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  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 _schemas = require("../util/schemas");
  13. var _getElementType = _interopRequireDefault(require("../util/getElementType"));
  14. var _isAbstractRole = _interopRequireDefault(require("../util/isAbstractRole"));
  15. var _isHiddenFromScreenReader = _interopRequireDefault(require("../util/isHiddenFromScreenReader"));
  16. var _isInteractiveElement = _interopRequireDefault(require("../util/isInteractiveElement"));
  17. var _isInteractiveRole = _interopRequireDefault(require("../util/isInteractiveRole"));
  18. var _isNonInteractiveElement = _interopRequireDefault(require("../util/isNonInteractiveElement"));
  19. var _isNonInteractiveRole = _interopRequireDefault(require("../util/isNonInteractiveRole"));
  20. var _isPresentationRole = _interopRequireDefault(require("../util/isPresentationRole"));
  21. /**
  22. * @fileoverview Enforce non-interactive elements have no interactive handlers.
  23. * @author Jese Beach
  24. *
  25. */
  26. // ----------------------------------------------------------------------------
  27. // Rule Definition
  28. // ----------------------------------------------------------------------------
  29. var errorMessage = 'Non-interactive elements should not be assigned mouse or keyboard event listeners.';
  30. var domElements = (0, _toConsumableArray2["default"])(_ariaQuery.dom.keys());
  31. var defaultInteractiveProps = [].concat(_jsxAstUtils.eventHandlersByType.focus, _jsxAstUtils.eventHandlersByType.image, _jsxAstUtils.eventHandlersByType.keyboard, _jsxAstUtils.eventHandlersByType.mouse);
  32. var schema = (0, _schemas.generateObjSchema)({
  33. handlers: _schemas.arraySchema
  34. });
  35. var _default = {
  36. meta: {
  37. docs: {
  38. url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-noninteractive-element-interactions.md',
  39. description: 'Non-interactive elements should not be assigned mouse or keyboard event listeners.',
  40. errorOptions: true
  41. },
  42. schema: [schema]
  43. },
  44. create: function create(context) {
  45. var options = context.options;
  46. var elementType = (0, _getElementType["default"])(context);
  47. return {
  48. JSXOpeningElement: function JSXOpeningElement(node) {
  49. var attributes = node.attributes;
  50. var type = elementType(node);
  51. var config = options[0] || {};
  52. var interactiveProps = config.handlers || defaultInteractiveProps; // Allow overrides from rule configuration for specific elements and roles.
  53. if ((0, _has["default"])(config, type)) {
  54. attributes = attributes.filter(function (attr) {
  55. return attr.type !== 'JSXSpreadAttribute' && !(0, _arrayIncludes["default"])(config[type], (0, _jsxAstUtils.propName)(attr));
  56. });
  57. }
  58. var hasInteractiveProps = interactiveProps.some(function (prop) {
  59. return (0, _jsxAstUtils.hasProp)(attributes, prop) && (0, _jsxAstUtils.getPropValue)((0, _jsxAstUtils.getProp)(attributes, prop)) != null;
  60. });
  61. if (!(0, _arrayIncludes["default"])(domElements, type)) {
  62. // Do not test higher level JSX components, as we do not know what
  63. // low-level DOM element this maps to.
  64. return;
  65. }
  66. if (!hasInteractiveProps || (0, _isHiddenFromScreenReader["default"])(type, attributes) || (0, _isPresentationRole["default"])(type, attributes)) {
  67. // Presentation is an intentional signal from the author that this
  68. // element is not meant to be perceivable. For example, a click screen
  69. // to close a dialog .
  70. return;
  71. }
  72. if ((0, _isInteractiveElement["default"])(type, attributes) || (0, _isInteractiveRole["default"])(type, attributes) || !(0, _isNonInteractiveElement["default"])(type, attributes) && !(0, _isNonInteractiveRole["default"])(type, attributes) || (0, _isAbstractRole["default"])(type, attributes)) {
  73. // This rule has no opinion about abtract roles.
  74. return;
  75. } // Visible, non-interactive elements should not have an interactive handler.
  76. context.report({
  77. node,
  78. message: errorMessage
  79. });
  80. }
  81. };
  82. }
  83. };
  84. exports["default"] = _default;
  85. module.exports = exports.default;