no-static-element-interactions.js 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
  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 _schemas = require("../util/schemas");
  10. var _getElementType = _interopRequireDefault(require("../util/getElementType"));
  11. var _isAbstractRole = _interopRequireDefault(require("../util/isAbstractRole"));
  12. var _isHiddenFromScreenReader = _interopRequireDefault(require("../util/isHiddenFromScreenReader"));
  13. var _isInteractiveElement = _interopRequireDefault(require("../util/isInteractiveElement"));
  14. var _isInteractiveRole = _interopRequireDefault(require("../util/isInteractiveRole"));
  15. var _isNonInteractiveElement = _interopRequireDefault(require("../util/isNonInteractiveElement"));
  16. var _isNonInteractiveRole = _interopRequireDefault(require("../util/isNonInteractiveRole"));
  17. var _isNonLiteralProperty = _interopRequireDefault(require("../util/isNonLiteralProperty"));
  18. var _isPresentationRole = _interopRequireDefault(require("../util/isPresentationRole"));
  19. /**
  20. * @fileoverview Enforce static elements have no interactive handlers.
  21. * @author Ethan Cohen
  22. *
  23. */
  24. // ----------------------------------------------------------------------------
  25. // Rule Definition
  26. // ----------------------------------------------------------------------------
  27. 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.';
  28. var defaultInteractiveProps = [].concat(_jsxAstUtils.eventHandlersByType.focus, _jsxAstUtils.eventHandlersByType.keyboard, _jsxAstUtils.eventHandlersByType.mouse);
  29. var schema = (0, _schemas.generateObjSchema)({
  30. handlers: _schemas.arraySchema
  31. });
  32. var _default = exports["default"] = {
  33. meta: {
  34. docs: {
  35. url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-static-element-interactions.md',
  36. description: 'Enforce that non-interactive, visible elements (such as `<div>`) that have click handlers use the role attribute.'
  37. },
  38. schema: [schema]
  39. },
  40. create: function create(context) {
  41. var options = context.options;
  42. var elementType = (0, _getElementType["default"])(context);
  43. return {
  44. JSXOpeningElement: function (_JSXOpeningElement) {
  45. function JSXOpeningElement(_x) {
  46. return _JSXOpeningElement.apply(this, arguments);
  47. }
  48. JSXOpeningElement.toString = function () {
  49. return _JSXOpeningElement.toString();
  50. };
  51. return JSXOpeningElement;
  52. }(function (node) {
  53. var attributes = node.attributes;
  54. var type = elementType(node);
  55. var _ref = options[0] || {},
  56. allowExpressionValues = _ref.allowExpressionValues,
  57. _ref$handlers = _ref.handlers,
  58. handlers = _ref$handlers === void 0 ? defaultInteractiveProps : _ref$handlers;
  59. var hasInteractiveProps = handlers.some(function (prop) {
  60. return (0, _jsxAstUtils.hasProp)(attributes, prop) && (0, _jsxAstUtils.getPropValue)((0, _jsxAstUtils.getProp)(attributes, prop)) != null;
  61. });
  62. if (!_ariaQuery.dom.has(type)) {
  63. // Do not test higher level JSX components, as we do not know what
  64. // low-level DOM element this maps to.
  65. return;
  66. }
  67. if (!hasInteractiveProps || (0, _isHiddenFromScreenReader["default"])(type, attributes) || (0, _isPresentationRole["default"])(type, attributes)) {
  68. // Presentation is an intentional signal from the author that this
  69. // element is not meant to be perceivable. For example, a click screen
  70. // to close a dialog .
  71. return;
  72. }
  73. 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)) {
  74. // This rule has no opinion about abstract roles.
  75. return;
  76. }
  77. if (allowExpressionValues === true && (0, _isNonLiteralProperty["default"])(attributes, 'role')) {
  78. // Special case if role is assigned using ternary with literals on both side
  79. var roleProp = (0, _jsxAstUtils.getProp)(attributes, 'role');
  80. if (roleProp && roleProp.type === 'JSXAttribute' && roleProp.value.type === 'JSXExpressionContainer') {
  81. if (roleProp.value.expression.type === 'ConditionalExpression') {
  82. if (roleProp.value.expression.consequent.type === 'Literal' && roleProp.value.expression.alternate.type === 'Literal') {
  83. return;
  84. }
  85. }
  86. }
  87. return;
  88. }
  89. // Visible, non-interactive elements should not have an interactive handler.
  90. context.report({
  91. node,
  92. message: errorMessage
  93. });
  94. })
  95. };
  96. }
  97. };
  98. module.exports = exports.default;