utils.js 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373
  1. function mapTags(tag) {
  2. let ret = ''
  3. switch (tag) {
  4. case 'A':
  5. ret = 'Link'
  6. break
  7. case 'BUTTON':
  8. ret = 'Button'
  9. break
  10. case 'IMG':
  11. ret = 'Image'
  12. break
  13. case 'INPUT':
  14. ret = 'Textbox'
  15. break
  16. case 'TEXTAREA':
  17. ret = 'Textbox'
  18. break
  19. default:
  20. ret = ''
  21. // ret = 'Text'
  22. break
  23. }
  24. return ret
  25. }
  26. function extractTextForFocus(e) {
  27. let meaningfulNode = e.target
  28. // 如果天然能focus,但没有被加上tabindex属性,比如focus到了第三方组件内部的可focus元素,直接返回。
  29. if (
  30. ['A', 'AREA', 'BUTTON', 'INPUT', 'SELECT', 'IFRAME'].includes(meaningfulNode.tagName) &&
  31. !meaningfulNode.getAttribute('tabindex')
  32. ) {
  33. return
  34. }
  35. while (!meaningfulNode.getAttribute || !meaningfulNode.getAttribute('tabindex')) {
  36. meaningfulNode = meaningfulNode.parentNode
  37. if (!meaningfulNode) {
  38. return
  39. }
  40. }
  41. // 约定:tabindex属性值为-1的元素只用于在点击有data-aria-xxx-area attribute的区域包裹元素的子孙元素时,避免focus到区域包裹元素。
  42. if (meaningfulNode.getAttribute('tabindex') === '-1') {
  43. return
  44. }
  45. let elemType = ''
  46. const ariaLabel = meaningfulNode.getAttribute('aria-label')
  47. if (ariaLabel !== null) {
  48. elemType = ariaLabel
  49. } else {
  50. elemType = mapTags(meaningfulNode.tagName)
  51. }
  52. let elemDisc = ''
  53. const ariaDescription = meaningfulNode.getAttribute('aria-description')
  54. if (ariaDescription !== null) {
  55. elemDisc = ariaDescription
  56. } else {
  57. elemDisc = meaningfulNode.innerText
  58. }
  59. return {
  60. elemType,
  61. elemDisc,
  62. ariaNode: meaningfulNode,
  63. }
  64. }
  65. let lastMeaningfulNode = null
  66. function extractTextForMouseOver(e) {
  67. let meaningfulNode = e.target
  68. while (!meaningfulNode.getAttribute || !meaningfulNode.getAttribute('tabindex')) {
  69. meaningfulNode = meaningfulNode.parentNode
  70. if (!meaningfulNode) {
  71. lastMeaningfulNode = null
  72. return
  73. }
  74. }
  75. if (meaningfulNode.getAttribute('tabindex') === '-1') {
  76. lastMeaningfulNode = null
  77. return
  78. }
  79. // mouseover事件冒泡到有data-aria-xxx-area attribute的区域包裹元素时,不应该提取该区域包裹元素的无障碍辅助信息。
  80. if (
  81. meaningfulNode.getAttribute('data-aria-navigation-area') !== null ||
  82. meaningfulNode.getAttribute('data-aria-viewport-area') !== null ||
  83. meaningfulNode.getAttribute('data-aria-interaction-area') !== null
  84. ) {
  85. lastMeaningfulNode = null
  86. return
  87. }
  88. // 如果只是在需要朗读的子元素之间进进出出,第一次需要朗读,以后就不需要朗读了。
  89. let relatedMeaningfulNode = e.relatedTarget
  90. while (relatedMeaningfulNode && (!relatedMeaningfulNode.getAttribute || !relatedMeaningfulNode.getAttribute('tabindex'))) {
  91. relatedMeaningfulNode = relatedMeaningfulNode.parentNode
  92. }
  93. if (relatedMeaningfulNode === meaningfulNode && lastMeaningfulNode === meaningfulNode) {
  94. return
  95. }
  96. lastMeaningfulNode = meaningfulNode
  97. let elemType = ''
  98. const ariaLabel = meaningfulNode.getAttribute('aria-label')
  99. if (ariaLabel !== null) {
  100. elemType = ariaLabel
  101. } else {
  102. elemType = mapTags(meaningfulNode.tagName)
  103. }
  104. let elemDisc = ''
  105. const ariaDescription = meaningfulNode.getAttribute('aria-description')
  106. if (ariaDescription !== null) {
  107. elemDisc = ariaDescription
  108. } else {
  109. elemDisc = meaningfulNode.innerText
  110. }
  111. return {
  112. elemType,
  113. elemDisc,
  114. ariaNode: meaningfulNode,
  115. }
  116. }
  117. function isObject(p) {
  118. return Object.prototype.toString.call(p) === '[object Object]'
  119. }
  120. // 判断两个对象内容是否相同
  121. function isSameObject(object1, object2) {
  122. const keys1 = Object.keys(object1)
  123. const keys2 = Object.keys(object2)
  124. if (keys1.length !== keys2.length) {
  125. return false
  126. }
  127. for (let index = 0; index < keys1.length; index++) {
  128. const val1 = object1[keys1[index]]
  129. const val2 = object2[keys2[index]]
  130. const areObjects = isObject(val1) && isObject(val2)
  131. if (
  132. (areObjects && !isSameObject(val1, val2)) ||
  133. (!areObjects && (val1 !== val2))
  134. ) {
  135. return false
  136. }
  137. }
  138. return true
  139. }
  140. function getAndFocusNextNodeWithCustomAttribute(attriName) {
  141. const startNode = (document.activeElement || document.body)
  142. const treeWalker = document.createTreeWalker(document.body, NodeFilter.SHOW_ELEMENT)
  143. treeWalker.currentNode = startNode
  144. let targetNode = null
  145. // eslint-disable-next-line
  146. while(true) {
  147. const nextNode = treeWalker.nextNode()
  148. if (!nextNode) {
  149. console.log('往下没找到')
  150. break
  151. }
  152. if (nextNode.dataset[attriName] !== undefined) {
  153. console.log('往下找到了')
  154. targetNode = nextNode
  155. break
  156. }
  157. }
  158. if (!targetNode && (startNode !== document.body)) {
  159. treeWalker.currentNode = document.body
  160. // eslint-disable-next-line
  161. while(true) {
  162. const nextNode = treeWalker.nextNode()
  163. if (!nextNode) {
  164. console.log('往上也没找到')
  165. break
  166. }
  167. if (nextNode.dataset[attriName] !== undefined) {
  168. console.log('往上找到了')
  169. targetNode = nextNode
  170. break
  171. }
  172. }
  173. }
  174. if (targetNode) {
  175. // 如果重复选中某一区域,需要重新触发focus,所以先blur一下
  176. if (document.activeElement === targetNode) {
  177. targetNode.blur()
  178. }
  179. targetNode.focus()
  180. // 如果无法focus,就强行focus
  181. if (document.activeElement !== targetNode) {
  182. targetNode.setAttribute('tabindex', '0')
  183. targetNode.focus()
  184. }
  185. }
  186. return targetNode
  187. }
  188. function __focusNextFocusableNode(treeWalker) {
  189. // eslint-disable-next-line
  190. while(true) {
  191. const nextNode = treeWalker.nextNode()
  192. if (!nextNode) {
  193. return false
  194. }
  195. if (nextNode.focus) {
  196. nextNode.focus()
  197. if (document.activeElement === nextNode && nextNode.tabIndex !== -1) {
  198. return true
  199. }
  200. }
  201. }
  202. }
  203. function iterateOnFocusableNode(startNode, focusedNodeHandler) {
  204. const treeWalker = document.createTreeWalker(document.body, NodeFilter.SHOW_ELEMENT)
  205. treeWalker.currentNode = startNode
  206. treeWalker.currentNode.focus()
  207. if (document.activeElement === treeWalker.currentNode) {
  208. // console.log('起始节点可以focus')
  209. } else {
  210. // console.log('起始节点不可以focus,focus到下一节点。')
  211. const ret = __focusNextFocusableNode(treeWalker)
  212. if (!ret) {
  213. return
  214. }
  215. }
  216. const iterator = () => {
  217. focusedNodeHandler(treeWalker.currentNode).then(() => {
  218. const result = __focusNextFocusableNode(treeWalker)
  219. if (result) {
  220. // console.log('遍历到下一个节点!')
  221. iterator()
  222. } else {
  223. // console.log('遍历结束!')
  224. }
  225. }).catch((e) => {
  226. // console.log('遍历中止!', e)
  227. })
  228. }
  229. iterator()
  230. }
  231. /**
  232. * 返回一个自带消抖效果的函数,用res表示。
  233. *
  234. * fn: 需要被消抖的函数
  235. * delay: 消抖时长
  236. * isImmediateCall: 是否在一组操作中的第一次调用时立即执行fn
  237. * isRememberLastCall:是否在一组中最后一次调用后等delay时长再执行fn
  238. */
  239. function debounce(fn, delay, isImmediateCall = false, isRememberLastCall = true) {
  240. console.assert(isImmediateCall || isRememberLastCall, 'isImmediateCall 和 isRememberLastCall 至少应有一个是true,否则没有意义!')
  241. let timer = null
  242. // 上次调用的时刻
  243. let lastCallTime = 0
  244. if (isImmediateCall && !isRememberLastCall) {
  245. return function (...args) {
  246. const currentTime = Date.now()
  247. if (currentTime - lastCallTime >= delay) {
  248. fn.apply(this, args)
  249. }
  250. lastCallTime = currentTime
  251. }
  252. } else if (!isImmediateCall && isRememberLastCall) {
  253. return function (...args) {
  254. if (timer) {
  255. clearTimeout(timer)
  256. }
  257. timer = setTimeout(() => {
  258. fn.apply(this, args)
  259. }, delay)
  260. }
  261. } else if (isImmediateCall && isRememberLastCall) {
  262. return function (...args) {
  263. const currentTime = Date.now()
  264. if (currentTime - lastCallTime >= delay) { // 一组操作中的第一次
  265. fn.apply(this, args)
  266. lastCallTime = currentTime
  267. return
  268. } else { // 一组中的后续调用
  269. if (timer) { // 在此之前存在中间调用
  270. lastCallTime = currentTime
  271. clearTimeout(timer)
  272. }
  273. timer = setTimeout(() => {
  274. fn.apply(this, args)
  275. lastCallTime = 0
  276. timer = null
  277. }, delay)
  278. }
  279. }
  280. } else {
  281. console.error('不应该执行到这里!')
  282. }
  283. }
  284. class DebounceScheduler {
  285. constructor(fn, delay, context, isImmediateCall = false) {
  286. this.job = fn
  287. this.delay = delay
  288. this.context = context
  289. this.timer = null
  290. this.lastCallTime = 0
  291. this.isImmediateCall = isImmediateCall
  292. }
  293. planToDo(...args) {
  294. if (!this.isImmediateCall) {
  295. if (this.timer) {
  296. clearTimeout(this.timer)
  297. this.timer = null
  298. }
  299. this.timer = setTimeout(() => {
  300. this.job.apply(this.context, args)
  301. }, this.delay)
  302. } else {
  303. const currentTime = Date.now()
  304. if (currentTime - this.lastCallTime >= this.delay) { // 一组操作中的第一次
  305. this.job.apply(this.context, args)
  306. this.lastCallTime = currentTime
  307. return
  308. } else { // 一组中的后续调用
  309. if (this.timer) { // 在此之前存在中间调用
  310. this.lastCallTime = currentTime
  311. clearTimeout(this.timer)
  312. this.timer = null
  313. }
  314. this.timer = setTimeout(() => {
  315. this.job.apply(this.context, args)
  316. this.lastCallTime = 0
  317. this.timer = null
  318. }, this.delay)
  319. }
  320. }
  321. }
  322. cancel() {
  323. if (this.timer) {
  324. clearTimeout(this.timer)
  325. this.timer = null
  326. }
  327. }
  328. }
  329. export default {
  330. mapTags,
  331. extractTextForFocus,
  332. extractTextForMouseOver,
  333. isSameObject,
  334. getAndFocusNextNodeWithCustomAttribute,
  335. iterateOnFocusableNode,
  336. debounce,
  337. DebounceScheduler,
  338. }