isInteractiveElement.js 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  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 _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
  8. var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
  9. var _ariaQuery = require("aria-query");
  10. var _axobjectQuery = require("axobject-query");
  11. var _arrayIncludes = _interopRequireDefault(require("array-includes"));
  12. var _arrayPrototype = _interopRequireDefault(require("array.prototype.flatmap"));
  13. var _Iterator = _interopRequireDefault(require("es-iterator-helpers/Iterator.from"));
  14. var _IteratorPrototype = _interopRequireDefault(require("es-iterator-helpers/Iterator.prototype.filter"));
  15. var _IteratorPrototype2 = _interopRequireDefault(require("es-iterator-helpers/Iterator.prototype.some"));
  16. var _attributesComparator = _interopRequireDefault(require("./attributesComparator"));
  17. // import iterFlatMap from 'es-iterator-helpers/Iterator.prototype.flatMap';
  18. var roleKeys = (0, _toConsumableArray2["default"])(_ariaQuery.roles.keys());
  19. var elementRoleEntries = (0, _toConsumableArray2["default"])(_ariaQuery.elementRoles);
  20. var nonInteractiveRoles = new Set(roleKeys.filter(function (name) {
  21. var role = _ariaQuery.roles.get(name);
  22. return !role["abstract"]
  23. // 'toolbar' does not descend from widget, but it does support
  24. // aria-activedescendant, thus in practice we treat it as a widget.
  25. && name !== 'toolbar' && !role.superClass.some(function (classes) {
  26. return (0, _arrayIncludes["default"])(classes, 'widget');
  27. });
  28. }).concat(
  29. // The `progressbar` is descended from `widget`, but in practice, its
  30. // value is always `readonly`, so we treat it as a non-interactive role.
  31. 'progressbar'));
  32. var interactiveRoles = new Set(roleKeys.filter(function (name) {
  33. var role = _ariaQuery.roles.get(name);
  34. return !role["abstract"]
  35. // The `progressbar` is descended from `widget`, but in practice, its
  36. // value is always `readonly`, so we treat it as a non-interactive role.
  37. && name !== 'progressbar' && role.superClass.some(function (classes) {
  38. return (0, _arrayIncludes["default"])(classes, 'widget');
  39. });
  40. }).concat(
  41. // 'toolbar' does not descend from widget, but it does support
  42. // aria-activedescendant, thus in practice we treat it as a widget.
  43. 'toolbar'));
  44. // TODO: convert to use iterFlatMap and iterFrom
  45. var interactiveElementRoleSchemas = (0, _arrayPrototype["default"])(elementRoleEntries, function (_ref) {
  46. var _ref2 = (0, _slicedToArray2["default"])(_ref, 2),
  47. elementSchema = _ref2[0],
  48. rolesArr = _ref2[1];
  49. return rolesArr.some(function (role) {
  50. return interactiveRoles.has(role);
  51. }) ? [elementSchema] : [];
  52. });
  53. // TODO: convert to use iterFlatMap and iterFrom
  54. var nonInteractiveElementRoleSchemas = (0, _arrayPrototype["default"])(elementRoleEntries, function (_ref3) {
  55. var _ref4 = (0, _slicedToArray2["default"])(_ref3, 2),
  56. elementSchema = _ref4[0],
  57. rolesArr = _ref4[1];
  58. return rolesArr.every(function (role) {
  59. return nonInteractiveRoles.has(role);
  60. }) ? [elementSchema] : [];
  61. });
  62. var interactiveAXObjects = new Set((0, _IteratorPrototype["default"])((0, _Iterator["default"])(_axobjectQuery.AXObjects.keys()), function (name) {
  63. return _axobjectQuery.AXObjects.get(name).type === 'widget';
  64. }));
  65. // TODO: convert to use iterFlatMap and iterFrom
  66. var interactiveElementAXObjectSchemas = (0, _arrayPrototype["default"])((0, _toConsumableArray2["default"])(_axobjectQuery.elementAXObjects), function (_ref5) {
  67. var _ref6 = (0, _slicedToArray2["default"])(_ref5, 2),
  68. elementSchema = _ref6[0],
  69. AXObjectsArr = _ref6[1];
  70. return AXObjectsArr.every(function (role) {
  71. return interactiveAXObjects.has(role);
  72. }) ? [elementSchema] : [];
  73. });
  74. function checkIsInteractiveElement(tagName, attributes) {
  75. function elementSchemaMatcher(elementSchema) {
  76. return tagName === elementSchema.name && (0, _attributesComparator["default"])(elementSchema.attributes, attributes);
  77. }
  78. // Check in elementRoles for inherent interactive role associations for
  79. // this element.
  80. var isInherentInteractiveElement = (0, _IteratorPrototype2["default"])((0, _Iterator["default"])(interactiveElementRoleSchemas), elementSchemaMatcher);
  81. if (isInherentInteractiveElement) {
  82. return true;
  83. }
  84. // Check in elementRoles for inherent non-interactive role associations for
  85. // this element.
  86. var isInherentNonInteractiveElement = (0, _IteratorPrototype2["default"])((0, _Iterator["default"])(nonInteractiveElementRoleSchemas), elementSchemaMatcher);
  87. if (isInherentNonInteractiveElement) {
  88. return false;
  89. }
  90. // Check in elementAXObjects for AX Tree associations for this element.
  91. var isInteractiveAXElement = (0, _IteratorPrototype2["default"])((0, _Iterator["default"])(interactiveElementAXObjectSchemas), elementSchemaMatcher);
  92. if (isInteractiveAXElement) {
  93. return true;
  94. }
  95. return false;
  96. }
  97. /**
  98. * Returns boolean indicating whether the given element is
  99. * interactive on the DOM or not. Usually used when an element
  100. * has a dynamic handler on it and we need to discern whether or not
  101. * it's intention is to be interacted with on the DOM.
  102. */
  103. var isInteractiveElement = function isInteractiveElement(tagName, attributes) {
  104. // Do not test higher level JSX components, as we do not know what
  105. // low-level DOM element this maps to.
  106. if (!_ariaQuery.dom.has(tagName)) {
  107. return false;
  108. }
  109. return checkIsInteractiveElement(tagName, attributes);
  110. };
  111. var _default = exports["default"] = isInteractiveElement;
  112. module.exports = exports.default;