isNonInteractiveElement.js 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  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'
  26. // This role is meant to have no semantic value.
  27. // @see https://www.w3.org/TR/wai-aria-1.2/#generic
  28. && name !== 'generic'
  29. // Whereas ARIA makes a distinction between cell and gridcell, the AXObject
  30. // treats them both as CellRole and since gridcell is interactive, we consider
  31. // cell interactive as well.
  32. && name !== 'cell' && !role.superClass.some(function (classes) {
  33. return (0, _arrayIncludes["default"])(classes, 'widget');
  34. });
  35. }).concat(
  36. // The `progressbar` is descended from `widget`, but in practice, its
  37. // value is always `readonly`, so we treat it as a non-interactive role.
  38. 'progressbar'));
  39. var interactiveRoles = new Set(roleKeys.filter(function (name) {
  40. var role = _ariaQuery.roles.get(name);
  41. return !role["abstract"]
  42. // The `progressbar` is descended from `widget`, but in practice, its
  43. // value is always `readonly`, so we treat it as a non-interactive role.
  44. && name !== 'progressbar'
  45. // This role is meant to have no semantic value.
  46. // @see https://www.w3.org/TR/wai-aria-1.2/#generic
  47. && name !== 'generic' && role.superClass.some(function (classes) {
  48. return (0, _arrayIncludes["default"])(classes, 'widget');
  49. });
  50. }).concat(
  51. // 'toolbar' does not descend from widget, but it does support
  52. // aria-activedescendant, thus in practice we treat it as a widget.
  53. 'toolbar'));
  54. // TODO: convert to use iterFlatMap and iterFrom
  55. var interactiveElementRoleSchemas = (0, _arrayPrototype["default"])(elementRoleEntries, function (_ref) {
  56. var _ref2 = (0, _slicedToArray2["default"])(_ref, 2),
  57. elementSchema = _ref2[0],
  58. rolesArr = _ref2[1];
  59. return rolesArr.some(function (role) {
  60. return interactiveRoles.has(role);
  61. }) ? [elementSchema] : [];
  62. });
  63. // TODO: convert to use iterFlatMap and iterFrom
  64. var nonInteractiveElementRoleSchemas = (0, _arrayPrototype["default"])(elementRoleEntries, function (_ref3) {
  65. var _ref4 = (0, _slicedToArray2["default"])(_ref3, 2),
  66. elementSchema = _ref4[0],
  67. rolesArr = _ref4[1];
  68. return rolesArr.every(function (role) {
  69. return nonInteractiveRoles.has(role);
  70. }) ? [elementSchema] : [];
  71. });
  72. var nonInteractiveAXObjects = new Set((0, _IteratorPrototype["default"])((0, _Iterator["default"])(_axobjectQuery.AXObjects.keys()), function (name) {
  73. return (0, _arrayIncludes["default"])(['window', 'structure'], _axobjectQuery.AXObjects.get(name).type);
  74. }));
  75. // TODO: convert to use iterFlatMap and iterFrom
  76. var nonInteractiveElementAXObjectSchemas = (0, _arrayPrototype["default"])((0, _toConsumableArray2["default"])(_axobjectQuery.elementAXObjects), function (_ref5) {
  77. var _ref6 = (0, _slicedToArray2["default"])(_ref5, 2),
  78. elementSchema = _ref6[0],
  79. AXObjectsArr = _ref6[1];
  80. return AXObjectsArr.every(function (role) {
  81. return nonInteractiveAXObjects.has(role);
  82. }) ? [elementSchema] : [];
  83. });
  84. function checkIsNonInteractiveElement(tagName, attributes) {
  85. function elementSchemaMatcher(elementSchema) {
  86. return tagName === elementSchema.name && (0, _attributesComparator["default"])(elementSchema.attributes, attributes);
  87. }
  88. // Check in elementRoles for inherent non-interactive role associations for
  89. // this element.
  90. var isInherentNonInteractiveElement = (0, _IteratorPrototype2["default"])((0, _Iterator["default"])(nonInteractiveElementRoleSchemas), elementSchemaMatcher);
  91. if (isInherentNonInteractiveElement) {
  92. return true;
  93. }
  94. // Check in elementRoles for inherent interactive role associations for
  95. // this element.
  96. var isInherentInteractiveElement = (0, _IteratorPrototype2["default"])((0, _Iterator["default"])(interactiveElementRoleSchemas), elementSchemaMatcher);
  97. if (isInherentInteractiveElement) {
  98. return false;
  99. }
  100. // Check in elementAXObjects for AX Tree associations for this element.
  101. var isNonInteractiveAXElement = (0, _IteratorPrototype2["default"])((0, _Iterator["default"])(nonInteractiveElementAXObjectSchemas), elementSchemaMatcher);
  102. if (isNonInteractiveAXElement) {
  103. return true;
  104. }
  105. return false;
  106. }
  107. /**
  108. * Returns boolean indicating whether the given element is a non-interactive
  109. * element. If the element has either a non-interactive role assigned or it
  110. * is an element with an inherently non-interactive role, then this utility
  111. * returns true. Elements that lack either an explicitly assigned role or
  112. * an inherent role are not considered. For those, this utility returns false
  113. * because a positive determination of interactiveness cannot be determined.
  114. */
  115. var isNonInteractiveElement = function isNonInteractiveElement(tagName, attributes) {
  116. // Do not test higher level JSX components, as we do not know what
  117. // low-level DOM element this maps to.
  118. if (!_ariaQuery.dom.has(tagName)) {
  119. return false;
  120. }
  121. // <header> elements do not technically have semantics, unless the
  122. // element is a direct descendant of <body>, and this plugin cannot
  123. // reliably test that.
  124. // @see https://www.w3.org/TR/wai-aria-practices/examples/landmarks/banner.html
  125. if (tagName === 'header') {
  126. return false;
  127. }
  128. return checkIsNonInteractiveElement(tagName, attributes);
  129. };
  130. var _default = exports["default"] = isNonInteractiveElement;
  131. module.exports = exports.default;