useAccessibility.js 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282
  1. "use strict";
  2. var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
  3. var _typeof = require("@babel/runtime/helpers/typeof");
  4. Object.defineProperty(exports, "__esModule", {
  5. value: true
  6. });
  7. exports.getFocusableElements = getFocusableElements;
  8. exports.refreshElements = void 0;
  9. exports.useAccessibility = useAccessibility;
  10. var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
  11. var _focus = require("rc-util/lib/Dom/focus");
  12. var _KeyCode = _interopRequireDefault(require("rc-util/lib/KeyCode"));
  13. var _raf = _interopRequireDefault(require("rc-util/lib/raf"));
  14. var React = _interopRequireWildcard(require("react"));
  15. var _IdContext = require("../context/IdContext");
  16. function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
  17. function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
  18. // destruct to reduce minify size
  19. var LEFT = _KeyCode.default.LEFT,
  20. RIGHT = _KeyCode.default.RIGHT,
  21. UP = _KeyCode.default.UP,
  22. DOWN = _KeyCode.default.DOWN,
  23. ENTER = _KeyCode.default.ENTER,
  24. ESC = _KeyCode.default.ESC,
  25. HOME = _KeyCode.default.HOME,
  26. END = _KeyCode.default.END;
  27. var ArrowKeys = [UP, DOWN, LEFT, RIGHT];
  28. function getOffset(mode, isRootLevel, isRtl, which) {
  29. var _offsets;
  30. var prev = 'prev';
  31. var next = 'next';
  32. var children = 'children';
  33. var parent = 'parent';
  34. // Inline enter is special that we use unique operation
  35. if (mode === 'inline' && which === ENTER) {
  36. return {
  37. inlineTrigger: true
  38. };
  39. }
  40. var inline = (0, _defineProperty2.default)((0, _defineProperty2.default)({}, UP, prev), DOWN, next);
  41. var horizontal = (0, _defineProperty2.default)((0, _defineProperty2.default)((0, _defineProperty2.default)((0, _defineProperty2.default)({}, LEFT, isRtl ? next : prev), RIGHT, isRtl ? prev : next), DOWN, children), ENTER, children);
  42. var vertical = (0, _defineProperty2.default)((0, _defineProperty2.default)((0, _defineProperty2.default)((0, _defineProperty2.default)((0, _defineProperty2.default)((0, _defineProperty2.default)({}, UP, prev), DOWN, next), ENTER, children), ESC, parent), LEFT, isRtl ? children : parent), RIGHT, isRtl ? parent : children);
  43. var offsets = {
  44. inline: inline,
  45. horizontal: horizontal,
  46. vertical: vertical,
  47. inlineSub: inline,
  48. horizontalSub: vertical,
  49. verticalSub: vertical
  50. };
  51. var type = (_offsets = offsets["".concat(mode).concat(isRootLevel ? '' : 'Sub')]) === null || _offsets === void 0 ? void 0 : _offsets[which];
  52. switch (type) {
  53. case prev:
  54. return {
  55. offset: -1,
  56. sibling: true
  57. };
  58. case next:
  59. return {
  60. offset: 1,
  61. sibling: true
  62. };
  63. case parent:
  64. return {
  65. offset: -1,
  66. sibling: false
  67. };
  68. case children:
  69. return {
  70. offset: 1,
  71. sibling: false
  72. };
  73. default:
  74. return null;
  75. }
  76. }
  77. function findContainerUL(element) {
  78. var current = element;
  79. while (current) {
  80. if (current.getAttribute('data-menu-list')) {
  81. return current;
  82. }
  83. current = current.parentElement;
  84. }
  85. // Normally should not reach this line
  86. /* istanbul ignore next */
  87. return null;
  88. }
  89. /**
  90. * Find focused element within element set provided
  91. */
  92. function getFocusElement(activeElement, elements) {
  93. var current = activeElement || document.activeElement;
  94. while (current) {
  95. if (elements.has(current)) {
  96. return current;
  97. }
  98. current = current.parentElement;
  99. }
  100. return null;
  101. }
  102. /**
  103. * Get focusable elements from the element set under provided container
  104. */
  105. function getFocusableElements(container, elements) {
  106. var list = (0, _focus.getFocusNodeList)(container, true);
  107. return list.filter(function (ele) {
  108. return elements.has(ele);
  109. });
  110. }
  111. function getNextFocusElement(parentQueryContainer, elements, focusMenuElement) {
  112. var offset = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 1;
  113. // Key on the menu item will not get validate parent container
  114. if (!parentQueryContainer) {
  115. return null;
  116. }
  117. // List current level menu item elements
  118. var sameLevelFocusableMenuElementList = getFocusableElements(parentQueryContainer, elements);
  119. // Find next focus index
  120. var count = sameLevelFocusableMenuElementList.length;
  121. var focusIndex = sameLevelFocusableMenuElementList.findIndex(function (ele) {
  122. return focusMenuElement === ele;
  123. });
  124. if (offset < 0) {
  125. if (focusIndex === -1) {
  126. focusIndex = count - 1;
  127. } else {
  128. focusIndex -= 1;
  129. }
  130. } else if (offset > 0) {
  131. focusIndex += 1;
  132. }
  133. focusIndex = (focusIndex + count) % count;
  134. // Focus menu item
  135. return sameLevelFocusableMenuElementList[focusIndex];
  136. }
  137. var refreshElements = exports.refreshElements = function refreshElements(keys, id) {
  138. var elements = new Set();
  139. var key2element = new Map();
  140. var element2key = new Map();
  141. keys.forEach(function (key) {
  142. var element = document.querySelector("[data-menu-id='".concat((0, _IdContext.getMenuId)(id, key), "']"));
  143. if (element) {
  144. elements.add(element);
  145. element2key.set(element, key);
  146. key2element.set(key, element);
  147. }
  148. });
  149. return {
  150. elements: elements,
  151. key2element: key2element,
  152. element2key: element2key
  153. };
  154. };
  155. function useAccessibility(mode, activeKey, isRtl, id, containerRef, getKeys, getKeyPath, triggerActiveKey, triggerAccessibilityOpen, originOnKeyDown) {
  156. var rafRef = React.useRef();
  157. var activeRef = React.useRef();
  158. activeRef.current = activeKey;
  159. var cleanRaf = function cleanRaf() {
  160. _raf.default.cancel(rafRef.current);
  161. };
  162. React.useEffect(function () {
  163. return function () {
  164. cleanRaf();
  165. };
  166. }, []);
  167. return function (e) {
  168. var which = e.which;
  169. if ([].concat(ArrowKeys, [ENTER, ESC, HOME, END]).includes(which)) {
  170. var keys = getKeys();
  171. var refreshedElements = refreshElements(keys, id);
  172. var _refreshedElements = refreshedElements,
  173. elements = _refreshedElements.elements,
  174. key2element = _refreshedElements.key2element,
  175. element2key = _refreshedElements.element2key;
  176. // First we should find current focused MenuItem/SubMenu element
  177. var activeElement = key2element.get(activeKey);
  178. var focusMenuElement = getFocusElement(activeElement, elements);
  179. var focusMenuKey = element2key.get(focusMenuElement);
  180. var offsetObj = getOffset(mode, getKeyPath(focusMenuKey, true).length === 1, isRtl, which);
  181. // Some mode do not have fully arrow operation like inline
  182. if (!offsetObj && which !== HOME && which !== END) {
  183. return;
  184. }
  185. // Arrow prevent default to avoid page scroll
  186. if (ArrowKeys.includes(which) || [HOME, END].includes(which)) {
  187. e.preventDefault();
  188. }
  189. var tryFocus = function tryFocus(menuElement) {
  190. if (menuElement) {
  191. var focusTargetElement = menuElement;
  192. // Focus to link instead of menu item if possible
  193. var link = menuElement.querySelector('a');
  194. if (link !== null && link !== void 0 && link.getAttribute('href')) {
  195. focusTargetElement = link;
  196. }
  197. var targetKey = element2key.get(menuElement);
  198. triggerActiveKey(targetKey);
  199. /**
  200. * Do not `useEffect` here since `tryFocus` may trigger async
  201. * which makes React sync update the `activeKey`
  202. * that force render before `useRef` set the next activeKey
  203. */
  204. cleanRaf();
  205. rafRef.current = (0, _raf.default)(function () {
  206. if (activeRef.current === targetKey) {
  207. focusTargetElement.focus();
  208. }
  209. });
  210. }
  211. };
  212. if ([HOME, END].includes(which) || offsetObj.sibling || !focusMenuElement) {
  213. // ========================== Sibling ==========================
  214. // Find walkable focus menu element container
  215. var parentQueryContainer;
  216. if (!focusMenuElement || mode === 'inline') {
  217. parentQueryContainer = containerRef.current;
  218. } else {
  219. parentQueryContainer = findContainerUL(focusMenuElement);
  220. }
  221. // Get next focus element
  222. var targetElement;
  223. var focusableElements = getFocusableElements(parentQueryContainer, elements);
  224. if (which === HOME) {
  225. targetElement = focusableElements[0];
  226. } else if (which === END) {
  227. targetElement = focusableElements[focusableElements.length - 1];
  228. } else {
  229. targetElement = getNextFocusElement(parentQueryContainer, elements, focusMenuElement, offsetObj.offset);
  230. }
  231. // Focus menu item
  232. tryFocus(targetElement);
  233. // ======================= InlineTrigger =======================
  234. } else if (offsetObj.inlineTrigger) {
  235. // Inline trigger no need switch to sub menu item
  236. triggerAccessibilityOpen(focusMenuKey);
  237. // =========================== Level ===========================
  238. } else if (offsetObj.offset > 0) {
  239. triggerAccessibilityOpen(focusMenuKey, true);
  240. cleanRaf();
  241. rafRef.current = (0, _raf.default)(function () {
  242. // Async should resync elements
  243. refreshedElements = refreshElements(keys, id);
  244. var controlId = focusMenuElement.getAttribute('aria-controls');
  245. var subQueryContainer = document.getElementById(controlId);
  246. // Get sub focusable menu item
  247. var targetElement = getNextFocusElement(subQueryContainer, refreshedElements.elements);
  248. // Focus menu item
  249. tryFocus(targetElement);
  250. }, 5);
  251. } else if (offsetObj.offset < 0) {
  252. var keyPath = getKeyPath(focusMenuKey, true);
  253. var parentKey = keyPath[keyPath.length - 2];
  254. var parentMenuElement = key2element.get(parentKey);
  255. // Focus menu item
  256. triggerAccessibilityOpen(parentKey, false);
  257. tryFocus(parentMenuElement);
  258. }
  259. }
  260. // Pass origin key down event
  261. originOnKeyDown === null || originOnKeyDown === void 0 || originOnKeyDown(e);
  262. };
  263. }