interactive-supports-focus.js 4.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  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 _isDisabledElement = _interopRequireDefault(require("../util/isDisabledElement"));
  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 _isPresentationRole = _interopRequireDefault(require("../util/isPresentationRole"));
  20. var _getTabIndex = _interopRequireDefault(require("../util/getTabIndex"));
  21. /**
  22. * @fileoverview Enforce that elements with onClick handlers must be tabbable.
  23. * @author Ethan Cohen
  24. *
  25. */
  26. // ----------------------------------------------------------------------------
  27. // Rule Definition
  28. // ----------------------------------------------------------------------------
  29. var schema = (0, _schemas.generateObjSchema)({
  30. // TODO: convert to use iterFilter and iterFrom
  31. tabbable: (0, _schemas.enumArraySchema)((0, _toConsumableArray2["default"])(_ariaQuery.roles.keys()).filter(function (name) {
  32. return !_ariaQuery.roles.get(name)["abstract"] && _ariaQuery.roles.get(name).superClass.some(function (klasses) {
  33. return (0, _arrayIncludes["default"])(klasses, 'widget');
  34. });
  35. }))
  36. });
  37. var interactiveProps = [].concat(_jsxAstUtils.eventHandlersByType.mouse, _jsxAstUtils.eventHandlersByType.keyboard);
  38. var _default = exports["default"] = {
  39. meta: {
  40. docs: {
  41. url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/interactive-supports-focus.md',
  42. description: 'Enforce that elements with interactive handlers like `onClick` must be focusable.'
  43. },
  44. schema: [schema]
  45. },
  46. create: function create(context) {
  47. var elementType = (0, _getElementType["default"])(context);
  48. return {
  49. JSXOpeningElement: function JSXOpeningElement(node) {
  50. var tabbable = context.options && context.options[0] && context.options[0].tabbable || [];
  51. var attributes = node.attributes;
  52. var type = elementType(node);
  53. var hasInteractiveProps = (0, _jsxAstUtils.hasAnyProp)(attributes, interactiveProps);
  54. var hasTabindex = (0, _getTabIndex["default"])((0, _jsxAstUtils.getProp)(attributes, 'tabIndex')) !== undefined;
  55. if (!_ariaQuery.dom.has(type)) {
  56. // Do not test higher level JSX components, as we do not know what
  57. // low-level DOM element this maps to.
  58. return;
  59. }
  60. if (!hasInteractiveProps || (0, _isDisabledElement["default"])(attributes) || (0, _isHiddenFromScreenReader["default"])(type, attributes) || (0, _isPresentationRole["default"])(type, attributes)) {
  61. // Presentation is an intentional signal from the author that this
  62. // element is not meant to be perceivable. For example, a click screen
  63. // to close a dialog .
  64. return;
  65. }
  66. if (hasInteractiveProps && (0, _isInteractiveRole["default"])(type, attributes) && !(0, _isInteractiveElement["default"])(type, attributes) && !(0, _isNonInteractiveElement["default"])(type, attributes) && !(0, _isNonInteractiveRole["default"])(type, attributes) && !hasTabindex) {
  67. var role = (0, _jsxAstUtils.getLiteralPropValue)((0, _jsxAstUtils.getProp)(attributes, 'role'));
  68. if ((0, _arrayIncludes["default"])(tabbable, role)) {
  69. // Always tabbable, tabIndex = 0
  70. context.report({
  71. node,
  72. message: "Elements with the '".concat(role, "' interactive role must be tabbable.")
  73. });
  74. } else {
  75. // Focusable, tabIndex = -1 or 0
  76. context.report({
  77. node,
  78. message: "Elements with the '".concat(role, "' interactive role must be focusable.")
  79. });
  80. }
  81. }
  82. }
  83. };
  84. }
  85. };
  86. module.exports = exports.default;