no-static-element-interactions.js 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  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 _schemas = require("../util/schemas");
  12. var _getElementType = _interopRequireDefault(require("../util/getElementType"));
  13. var _isAbstractRole = _interopRequireDefault(require("../util/isAbstractRole"));
  14. var _isHiddenFromScreenReader = _interopRequireDefault(require("../util/isHiddenFromScreenReader"));
  15. var _isInteractiveElement = _interopRequireDefault(require("../util/isInteractiveElement"));
  16. var _isInteractiveRole = _interopRequireDefault(require("../util/isInteractiveRole"));
  17. var _isNonInteractiveElement = _interopRequireDefault(require("../util/isNonInteractiveElement"));
  18. var _isNonInteractiveRole = _interopRequireDefault(require("../util/isNonInteractiveRole"));
  19. var _isNonLiteralProperty = _interopRequireDefault(require("../util/isNonLiteralProperty"));
  20. var _isPresentationRole = _interopRequireDefault(require("../util/isPresentationRole"));
  21. /**
  22. * @fileoverview Enforce static elements have no interactive handlers.
  23. * @author Ethan Cohen
  24. *
  25. */
  26. // ----------------------------------------------------------------------------
  27. // Rule Definition
  28. // ----------------------------------------------------------------------------
  29. var errorMessage = 'Avoid non-native interactive elements. If using native HTML is not possible, add an appropriate role and support for tabbing, mouse, keyboard, and touch inputs to an interactive content element.';
  30. var domElements = (0, _toConsumableArray2["default"])(_ariaQuery.dom.keys());
  31. var defaultInteractiveProps = [].concat(_jsxAstUtils.eventHandlersByType.focus, _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-static-element-interactions.md',
  39. description: 'Enforce that non-interactive, visible elements (such as `<div>`) that have click handlers use the role attribute.',
  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 _ref = options[0] || {},
  52. allowExpressionValues = _ref.allowExpressionValues,
  53. _ref$handlers = _ref.handlers,
  54. handlers = _ref$handlers === void 0 ? defaultInteractiveProps : _ref$handlers;
  55. var hasInteractiveProps = handlers.some(function (prop) {
  56. return (0, _jsxAstUtils.hasProp)(attributes, prop) && (0, _jsxAstUtils.getPropValue)((0, _jsxAstUtils.getProp)(attributes, prop)) != null;
  57. });
  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. }
  63. if (!hasInteractiveProps || (0, _isHiddenFromScreenReader["default"])(type, attributes) || (0, _isPresentationRole["default"])(type, attributes)) {
  64. // Presentation is an intentional signal from the author that this
  65. // element is not meant to be perceivable. For example, a click screen
  66. // to close a dialog .
  67. return;
  68. }
  69. 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)) {
  70. // This rule has no opinion about abstract roles.
  71. return;
  72. }
  73. if (allowExpressionValues === true && (0, _isNonLiteralProperty["default"])(attributes, 'role')) {
  74. // Special case if role is assigned using ternary with literals on both side
  75. var roleProp = (0, _jsxAstUtils.getProp)(attributes, 'role');
  76. if (roleProp && roleProp.type === 'JSXAttribute' && roleProp.value.type === 'JSXExpressionContainer') {
  77. if (roleProp.value.expression.type === 'ConditionalExpression') {
  78. if (roleProp.value.expression.consequent.type === 'Literal' && roleProp.value.expression.alternate.type === 'Literal') {
  79. return;
  80. }
  81. }
  82. }
  83. return;
  84. } // Visible, non-interactive elements should not have an interactive handler.
  85. context.report({
  86. node,
  87. message: errorMessage
  88. });
  89. }
  90. };
  91. }
  92. };
  93. exports["default"] = _default;
  94. module.exports = exports.default;