click-events-have-key-events.js 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  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 _isHiddenFromScreenReader = _interopRequireDefault(require("../util/isHiddenFromScreenReader"));
  14. var _isInteractiveElement = _interopRequireDefault(require("../util/isInteractiveElement"));
  15. var _isPresentationRole = _interopRequireDefault(require("../util/isPresentationRole"));
  16. /**
  17. * @fileoverview Enforce a clickable non-interactive element has at least 1 keyboard event listener.
  18. * @author Ethan Cohen
  19. */
  20. // ----------------------------------------------------------------------------
  21. // Rule Definition
  22. // ----------------------------------------------------------------------------
  23. var errorMessage = 'Visible, non-interactive elements with click handlers must have at least one keyboard listener.';
  24. var schema = (0, _schemas.generateObjSchema)();
  25. var domElements = (0, _toConsumableArray2["default"])(_ariaQuery.dom.keys());
  26. var _default = {
  27. meta: {
  28. docs: {
  29. url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/click-events-have-key-events.md',
  30. description: 'Enforce a clickable non-interactive element has at least one keyboard event listener.'
  31. },
  32. schema: [schema]
  33. },
  34. create: function create(context) {
  35. var elementType = (0, _getElementType["default"])(context);
  36. return {
  37. JSXOpeningElement: function JSXOpeningElement(node) {
  38. var props = node.attributes;
  39. if ((0, _jsxAstUtils.getProp)(props, 'onclick') === undefined) {
  40. return;
  41. }
  42. var type = elementType(node);
  43. var requiredProps = ['onkeydown', 'onkeyup', 'onkeypress'];
  44. if (!(0, _arrayIncludes["default"])(domElements, type)) {
  45. // Do not test higher level JSX components, as we do not know what
  46. // low-level DOM element this maps to.
  47. return;
  48. }
  49. if ((0, _isHiddenFromScreenReader["default"])(type, props) || (0, _isPresentationRole["default"])(type, props)) {
  50. return;
  51. }
  52. if ((0, _isInteractiveElement["default"])(type, props)) {
  53. return;
  54. }
  55. if ((0, _jsxAstUtils.hasAnyProp)(props, requiredProps)) {
  56. return;
  57. } // Visible, non-interactive elements with click handlers require one keyboard event listener.
  58. context.report({
  59. node,
  60. message: errorMessage
  61. });
  62. }
  63. };
  64. }
  65. };
  66. exports["default"] = _default;
  67. module.exports = exports.default;