-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
1308 lines (1114 loc) · 46.4 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { objToStr, isObj, isFun, getActiveElement, element, tick, isSelectableInput, isEnterEvent, isEscapeEvent, isTabForward, isTabBackward, findLowestCommonAncestorNode, getKeysFromStr } from "./utils";
/** 聚焦,如果是 input,则聚焦后选中 */
const focus = function(e) {
e.focus();
if (isSelectableInput(e))
e.select();
};
/** 尝试聚焦,如果聚焦失效,则下个 setTimeout 再次聚焦 */
const tickFocus = function(e) {
if (e == null) tick(() => e && focus(e));
else focus(e);
};
/** 是否匹配按键 */
const matchKeys = function(keys, e, prevI, curI) {
let matched = false;
for (const key of keys) {
if (isFun(key)) {
matched = key(e, prevI, curI);
} else {
const { shift, meta, alt, ctrl, commonKey } = key;
matched = ((shift && e.shiftKey) || !(shift || e.shiftKey)) &&
((meta && e.metaKey) || !(meta || e.metaKey)) &&
((alt && e.altKey) || !(alt || e.altKey)) &&
((ctrl && e.ctrlKey) || !(ctrl || e.ctrlKey)) &&
(commonKey == null || (commonKey === e.key));
}
if (matched) return matched; // true
}
return matched; // false
};
/** 转换用户输入的按键为程序可理解的按键 */
const convertKeys = function(keys, defaultKey) {
return [].concat(keys).map(k => typeof k === "string" ? getKeysFromStr(k) : k ?? defaultKey);
}
/** 获取根节点 */
const getRootNode = function(rootStr, listHead, listTail) {
return element(rootStr) ?? findLowestCommonAncestorNode(listHead, listTail);
};
/** 获取列表节点 */
const getListNodes = function(listAry) {
const list = listAry.map(item => element(item)).filter(item => item != null);
const head = list[0];
const tail = list.slice(-1)[0];
return { list, head, tail };
}
/** 获取封面节点 */
const getCoverNode = function(coverStr, coverIsRoot, root) {
return coverIsRoot ? root : element(coverStr);
}
/** 获取关键节点 */
const getKeyNodes = function(originRoot, originList, originCover, coverIsRoot) {
const { list, head, tail } = getListNodes(originList);
const root = getRootNode(originRoot, head, tail);
const cover = getCoverNode(originCover, coverIsRoot, root);
return {
root,
list, head, tail,
cover,
};
};
/** 用于处理节点属性可以传递数组的情况,用于入口和出口 */
const pickNodesAry = function(acc, cur) {
const isAryNodes = Array.isArray(cur.node);
const nodes = isAryNodes ? cur.node.map(n => ({
...cur,
node: n,
})) : cur;
return acc.concat(nodes);
};
/** 获取分割的出口 */
const splitExits = function(exits, root) {
/** 生效的节点是否在根元素内部(列表中) */
const isInnerRoot = node => isFun(node) || (node != null && root.contains(element(node))) || node == null;
const [keyExits, clickExits, focusExits, clickExits_wild, focusExits_wild, outListExits] = exits.reduce((acc, e) => {
let [key, click, focus, click_wild, focus_wild, outList] = acc;
const includeType = type => e.type?.includes(type);
if (isInnerRoot(e.node)) {
if (includeType("keydown")) key = key.concat(e);
if (includeType("click")) click = click.concat(e);
if (includeType("focus")) focus = focus.concat(e);
if (includeType("outlist")) outList = outList.concat(e);
} else {
if (includeType("click")) click_wild = click_wild.concat(e);
if (includeType("focus")) focus_wild = focus_wild.concat(e);
if (includeType("outlist")) outList = outList.concat(e);
}
return [key, click, focus, click_wild, focus_wild, outList];
}, new Array(6).fill([]));
const hasClickExits = clickExits.length > 0;
const hasFocusExits = focusExits.length > 0;
const hasKeyExits = keyExits.length > 0;
return {
keyExits, clickExits, focusExits, hasClickExits, hasFocusExits, hasKeyExits,
clickExits_wild, focusExits_wild,
outListExits,
};
}
/** 获取(生成)出口 */
const getExits = function(exit, onEscape, enabledCover, cover, trigger, delayToBlur) {
let tempExits = [].concat(exit).filter(o => o != null)
.map(ele => isObj(ele) ? ele : { node: ele })
.map(e => ({
...e,
preventDefault: e.preventDefault ?? true,
delay: e.delay ?? delayToBlur,
// undefined 表示用户没有主动设置
type: e.type === undefined ? [e.key == null ? '' : "keydown", e.node == null ? '' : "click"].filter(t => t !== '') : [].concat(e.type),
key: convertKeys(e.key),
}))
.reduce(pickNodesAry, []);
let _onEscape = isFun(onEscape) ? onEscape : onEscape === true ? tempExits[0]?.on ?? (() => {}) : onEscape;
/** 按下 esc 的出口 */
const escapeExit = isFun(_onEscape) ? {
node: null,
key: [isEscapeEvent],
on: _onEscape,
target: enabledCover ? cover : trigger,
type: ["keydown"],
} : null;
const exits = [escapeExit].concat(tempExits).filter(e => e != null);
return exits;
};
/** 延迟执行某些操作 */
const delayToProcess = function(delay, processor) {
const { promiseDelay, callbackDelay, commonDelay, delayRes } = getDelayType();
if (promiseDelay) delayRes.then(processor);
else if (callbackDelay) {} // 已执行完毕
else if (commonDelay) processor();
/** 获取聚焦或失焦时延迟的类型 */
function getDelayType() {
const isFunctionDelay = isFun(delay);
const delayRes = isFunctionDelay && delay(processor);
const promiseDelay = isFunctionDelay && objToStr(delayRes) === "[object Promise]" && typeof delayRes.then === "function";
const callbackDelay = isFunctionDelay && !promiseDelay;
const commonDelay = !promiseDelay && !callbackDelay; // 立即执行
return {
promiseDelay,
callbackDelay,
commonDelay,
delayRes,
};
}
};
/** 获取出口或者入口的目标 */
const getTarget = function(target, cover, list, root, enabledCover, activeIndex, defaultTarget, e) {
const isDefaultTarget = t => t == null || t === true;
// 空 target 走默认
if (isDefaultTarget(target))
return returnDefaultTarget();
// 函数 target 则传入节点执行
else if (isFun(target)) {
const gotTarget = target({ e, list, cover, root, last: list[activeIndex], lastI: activeIndex });
if (isDefaultTarget(gotTarget))
return returnDefaultTarget();
return gotTarget;
}
// 选择器字符串或者节点,则直接获取
else return element(target);
function returnDefaultTarget() {
if (enabledCover) return cover;
else return defaultTarget;
}
};
/** 保存的监听事件信息,方便监听和移除监听 */
class ListenersCache {
cache = [];
isEmpty = true;
push(node, type, handler) {
this.isEmpty = false;
this.cache.push({
node,
type,
handler,
});
}
clean() {
this.cache = [];
this.isEmpty = true;
}
addListeners() {
this.cache.forEach(l => l.node?.addEventListener(l.type, l.handler));
}
removeListeners() {
this.cache.forEach(l => l.node?.removeEventListener(l.type, l.handler));
this.clean();
}
}
/** 按键转发的缓存 */
class KeyForwardCache {
cache = new Map();
has(id) {
return this.cache.has(id);
}
push(id, node, handler) {
if (this.has(id)) return;
node.addEventListener("keydown", handler);
this.cache.set(id, {
node,
handler,
})
}
remove(id) {
const ids = [].concat(id);
ids.forEach(id => this.cache.get(id).node.removeEventListener("keydown", this.cache.get(id).handler));
}
}
/** 保存列表数据 */
class TabList {
data = [];
head = null;
tail = null;
prevI = -1;
curI = -1;
_prev = null;
_cur = null;
rangeBeforePrevCallback = false; // 范围模式下,当前是否在调用钩子回调(onMove、onPrev)之前
rangeBeforeNextCallback = false; // 范围模式下,当前是否在调用钩子回调(onMove、onNext)之前
get prev() {
return this._prev || this.data[this.prevI] || null; // _prev 可能由于 dom 未加载而为 null,为 null 则通过 prevI 取值
};
get cur() {
return this._cur || this.data[this.curI] || null;
};
set prev(v) {
this._prev = v;
};
set cur(v) {
this._cur = v;
};
update(list) {
this.data.splice(0, this.data.length);
Array.prototype.push.apply(this.data, list);
this.head = list[0];
this.tail = list.at(-1);
};
isEmpty() {
return this.data.length === 0;
};
has(i) {
return !!this.data[i];
};
record(cur, curI) {
this.recordPrev(this.cur, this.curI);
this.recordCur(cur, curI);
};
recordRange(cur) {
if (this.cur === cur || (this.cur == null && cur == null))
return;
this.record(cur, -1);
};
recordPrev(prev, prevI) {
this.prevI = prevI < 0 ? -1 : prevI;
this.prev = prev || null;
};
recordCur(cur, curI) {
this.curI = curI < 0 ? -1 : curI;
this.cur = cur || null;
};
recordSequenceByIdx(curI) {
const cur = this.data[curI];
if (this.curI === curI // this.curI 和 curI 必须不同
|| (this.curI < 0 && curI < 0)) // curI 为 -1 后,不会再次更新新的 -1
return;
this.record(cur, curI);
};
}
const focusFly = (...props) => {
const offset = 0 - (props[0] instanceof Array);
const rootNode = props[0 + offset];
const subNodes = props[1 + offset];
const options = props[2 + offset] ?? {};
if (!(Array.isArray(subNodes) && subNodes.length > 1))
throw new Error("请至少传入一个数组,数组至少包含两个可聚焦元素,用来表示列表的头和尾。");
const {
/** move: tab 序列,指定可以聚焦的元素,聚焦 list 内的元素 */
sequence,
/** move: 是否循环,设置后,尾元素的下个焦点是头元素,头元素的上个焦点是尾元素 */
loop,
/** move: 自定义前进焦点函数 */
next,
/** move: 自定义后退焦点函数 */
prev,
/** focus/blur: 触发器,如果使用 focusFly.enter 则不用设置,如果使用 entry.selector 则不用设置 */
trigger,
/** focus: 触发触发器的配置 */
entry,
/** blur: 触发退出触发器的配置 */
exit,
/** blur: 按下 esc 的行为,如果未设置,则取 exit.on */
onEscape,
/** 点击列表单项的响应,行为 */
onClick,
/** 移动的时候触发 */
onMove,
/** cover: 封面,默认情况,触发入口后首先聚焦封面,而不是子元素 */
cover: origin_cover,
/** 初始的列表中聚焦元素的序号 */
initialActive,
/** 矫正列表的焦点 */
correctionTarget,
/** 延迟挂载非触发器元素的事件,可以是一个返回 promise 的函数,可以是一个接收回调函数的函数 */
delayToFocus,
/** 延迟失焦,触发出口后等待执行 delayToBlur 完成后失焦 */
delayToBlur,
/** 每次退出列表回到入口是否移除列表事件 */
removeListenersEachExit = true,
/** 每次进入列表是否移除入口事件 */
removeListenersEachEnter,
/** 每次退出列表是否添加入口监听事件 */
addEntryListenersEachExit = true,
/** 阻止(列表移动)冒泡或捕获 */
stopPropagation: listStopPropagation = false,
/** 阻止(列表移动)默认行为 */
preventDefault,
/** 手动添加和移除监听事件,入口、列表、出口的监听事件,`removeListenersEachExit` 和 `removeListenersEachEnter` 将失效 */
manual,
/** 用于抹平 Safari 不同于其它浏览器,点击后 button 之类的元素不会被聚焦的问题 */
allowSafariToFocusAfterMousedown = true,
/** 用于内部调试 */
// demo = false,
} = options;
/** 入口们 */
const entries = [].concat(entry) // 转为数组
.filter(o => o != null) // 过滤空值
.map(ele => isObj(ele) ? ele : { node: ele }) // 元素转为对象,并且默认元素的值被看作对象的 node 属性
.map(entry => ({ // 对元素的属性进行默认处理
...entry,
preventDefault: entry.preventDefault ?? true,
delay: entry.delay ?? delayToFocus,
type: entry.type === undefined ? [entry.key == null ? '' : "keydown", entry.node == null ? '' : "click"].filter(t => t != '') : [].concat(entry.type),
onExit: entry.onExit === true ? entry.on : entry.onExit, // 这个入口是开关吗
key: convertKeys(entry.key),
}))
.reduce(pickNodesAry, []); // 处理元素的 node 属性是数组的情况,将它分解成多个元素
/** 是否是空入口 */
const hasNoEntry = entries.length === 0;
/** 带切换的入口,如果 entry.onExit 有值,代表这个入口同时也是出口,也就是开关 */
const toggles = new Set(entries.map(e => isFun(e.onExit) ? e.node : null).filter(n => n != null).map(n => element(n)));
/** 默认入口,默认情况下,会从出口回到这个入口 */
let _trigger = element(trigger || entries[0]?.node);
const {
/** 封面节点 */
node: coverNode,
enterKey: coverEnterKey,
onEnter: onEnterCover,
exit: exitCover,
} = isObj(origin_cover) ? origin_cover : {};
/** 是否已经打开封面选项 */
const enabledCover = origin_cover != null && origin_cover !== false && coverNode !== false;
/** 封面即根元素 */
const coverIsRoot = enabledCover && (origin_cover === true || coverNode === true || coverNode == null);
/** 退出封面,封面的出口们 */
const exitsCover = [].concat(exitCover) // 转为数组
.filter(e => e != null) // 过滤空值
.map(e => isObj(e) ? e : { key: e }) // 元素转为对象,并且默认元素的值被看作对象的 key 属性
.map(e => ({ // 对元素的属性进行默认处理
...e,
target: e.target ?? _trigger,
key: convertKeys(e.key),
}));
/** 是否使用默认的离开封面方法,也即 tab 和 shift-tab */
const isDefaultExitCover = enabledCover && exitsCover.length === 0;
/** 列表 */
const list = new TabList();
/** 根元素 */
let root = null;
/** 封面 */
let cover = null;
list.recordPrev(null, initialActive ?? -1);
const objNext = isObj(next) ? next : { key: next };
const {
key: isNext,
on: onNext,
} = {
...objNext,
key: convertKeys(objNext.key, isTabForward)
};
const objPrev = isObj(prev) ? prev : { key: prev };
const {
key: isPrev,
on: onPrev,
} = {
...objPrev,
key: convertKeys(objPrev.key, isTabBackward)
};
/** 禁用左上角 esc 出口 */
const disabledEsc = onEscape === false;
/** 取消循环则设置头和尾焦点 */
const isClamp = !(loop ?? true);
/** 是否打开列表序列,按照序列的顺序进行焦点导航 */
const enabledTabSequence = !!(next || prev || sequence); // 自定义前进或后退焦点函数,则设置 sequence 为 true
/** 移动列表,是否阻止默认行为 */
const listPreventDefault = preventDefault ?? enabledTabSequence;
/** 进入了列表 */
let trappedList = false;
/** 进入了封面 */
let trappedCover = false;
/** 是否已添加监听事件 */
const listListeners = new ListenersCache();
/** 是否已添加入口的监听事件 */
const entryListeners = new ListenersCache();
/** 按键转发,监听事件 */
const keyForwards = new KeyForwardCache();
if (!manual) { // 如果不是手动添加事件,则注册入口、列表相关(封面、列表、出口)的事件
// 入口点击事件
addEntryListeners();
// 如果有入口不需要延迟,则立即加载列表的监听事件
const hasImmediateEntry = (hasNoEntry ? [{}] : entries).some(({ delay }) => !delay);
if (hasImmediateEntry) {
const {
root: newRoot, list: newList, cover: newCover,
} = getKeyNodes(rootNode, subNodes, coverNode, coverIsRoot);
list.update(newList);
root = newRoot;
cover = newCover;
loadListRelatedListeners(root, list, cover);
}
}
const Return = {
/** 调用形式的入口 */
enter(entry) {
_trigger = _trigger || getActiveElement();
if (entry) {
const { on, target, delay } = entry;
return entryHandler({ fromInvoke: true }, on, target, delay);
} else {
for (let i = 0; i < entries.length; ++ i) {
const { on, type, node, target, delay } = entries[i];
const invokeType = "invoke";
if (type?.some(type => type == null || type === false || type === invokeType) || node == null) {
return entryHandler({ fromInvoke: true }, on, target, delay);
}
}
return entryHandler({ fromInvoke: true });
}
},
/** 调用形式的出口 */
exit(tempExit) {
const {
list: newList,
cover,
root,
} = getKeyNodes(rootNode, subNodes, coverNode, coverIsRoot);
if (tempExit) {
const { on, target: originTarget } = tempExit;
const target = element(originTarget);
return toExit(target, on);
} else {
const exits = getExits(exit, onEscape, enabledCover, cover, _trigger, delayToBlur);
for (let i = 0; i < exits.length; ++ i) {
const { on, type, target } = exits[i];
const invokeType = "invoke";
if (type?.some(type => type == null || type === false || type === invokeType)) {
return toExit(target, on);
}
}
}
function toExit(target, on) {
if (list.isEmpty()) list.update(newList);
return exitHandler({ fromInvoke: true }, on, target, false, cover, list.data, root);
}
},
/** 移除所有的监听事件 */
removeListeners() {
listListeners.removeListeners();
entryListeners.removeListeners();
},
/** 移除列表相关的事件 */
removeListRelatedListeners() {
listListeners.removeListeners();
},
/** 移除入口事件 */
removeEntryListeners() {
entryListeners.removeListeners();
},
/** 添加入口的监听事件 */
addEntryListeners() {
addEntryListeners();
},
/** 添加列表相关(封面、列表、出口)的监听事件 */
addListRelatedListeners() {
const {
root,
list: newList,
cover,
} = getKeyNodes(rootNode, subNodes, coverNode, coverIsRoot);
if (list.isEmpty()) list.update(newList);
loadListRelatedListeners(root, list, cover);
},
/** 添加转发 */
addForward(id, forward) {
let opts = null;
if (isFun(forward)) {
const {
root,
list: listData, head, tail,
cover,
} = getKeyNodes(rootNode, subNodes, coverNode, coverIsRoot);
opts = forward({ root, list: listData, head, tail, cover, curI: list.curI, prevI: list.prevI });
}
else opts = forward;
const { node: origin_node, on, key: origin_key, target: origin_target } = opts;
const node = element(origin_node);
const target = element(origin_target);
const keys = convertKeys(origin_key);
keyForwards.push(id, node, e => {
if (matchKeys(keys, e, list.prevI, list.curI)) {
e.preventDefault();
on?.();
tickFocus(target);
}
});
},
/** 移除转发 */
removeForward(id) {
keyForwards.remove(id);
},
/** 更新列表 */
updateList(newList) {
const _newList = newList.map(item => element(item)).filter(item => item != null);
list.update(_newList);
},
/** 当前聚焦的列表单项序号 */
i(newI) {
if (list.has(newI) && trappedList) {
list.recordSequenceByIdx(newI);
const { prev, prevI, cur, curI } = list;
onMove?.({ e: { fromI: true }, prev, prevI, cur, curI });
focus(subNodes[curI]);
return newI;
}
else return list.curI < 0 ? list.prevI : list.curI;
},
};
return Return;
/** 入口 handler */
function entryHandler(e, onEnter, target, delay, preventDefault, stopPropagation) {
// 如果已经在列表或者封面,则不再触发入口;出口不需要该操作,因为不存在从出口退出到出口的子元素的情况,相反,存在入口进入到入口子元素的情况。
if (trappedCover || trappedList) return;
preventDefault && e.preventDefault?.();
stopPropagation && e.stopPropagation?.();
Promise.resolve(onEnter?.(e)).then(_ => {
delayToProcess(delay, findNodesToLoadListenersAndFocus);
});
/** 寻找节点,加载事件监听器,聚焦 subNodes 或 coverNode */
function findNodesToLoadListenersAndFocus() {
if (list.isEmpty()) {
const { list: newList } = getListNodes(subNodes);
list.update(newList);
}
if (root == null)
root = getRootNode(rootNode, list.head, list.tail);
if (cover == null && enabledCover)
cover = getCoverNode(coverNode, coverIsRoot, root);
if (!manual)
loadListRelatedListeners(root, list, cover);
if (target !== false)
focusTarget(cover, list, root);
}
function focusTarget(cover, listInfo, rootNode) {
const list = listInfo.data;
const { prev, head, curI } = listInfo;
const defaultTarget = prev || head;
const gotTarget = getTarget(target, cover, list, rootNode, enabledCover, curI, defaultTarget, e);
if (enabledTabSequence) { // 序列模式
const targetIdx = list.indexOf(gotTarget);
if (targetIdx > -1) {
listInfo.recordSequenceByIdx(targetIdx); // 只有在聚焦列表元素时才设置,否则会破坏原有 curI
const { cur, curI } = listInfo;
onMove?.({ e, prev: null, cur, prevI: -1, curI });
trappedList = true;
}
} else { // 范围模式
if (rootNode.contains(gotTarget) && gotTarget !== cover) {
listInfo.recordRange(gotTarget);
const { cur, curI } = listInfo;
onMove?.({ e, prev: null, cur, prevI: -1, curI });
trappedList = true;
}
}
if (enabledCover && (gotTarget === cover || trappedList === true)) trappedCover = true;
tickFocus(gotTarget);
}
}
/** 出口 handler */
function exitHandler(e, on, target, delay, cover, listData, root, ef, preventDefault, stopPropagation) {
if (!trappedList ||
!(isFun(ef) ? ef({ e, prev: list.prev, cur: list.cur, prevI: list.prevI, curI: list.curI }) : true))
return false;
preventDefault && e.preventDefault?.(); // 阻止默认行为,例如 tab 到下一个元素,例如 entry button 触发 click 事件
stopPropagation && e.stopPropagation?.();
if (enabledTabSequence) list.recordSequenceByIdx(-1);
else list.recordRange(null);
trappedList = false;
const gotTarget = getTarget(target, cover, listData, root, enabledCover, list.curI, _trigger, e);
if (gotTarget) return exitListWithTarget();
else return exitListWithoutTarget();
/** 退出列表,有 target */
function exitListWithTarget() {
Promise.resolve(on?.(e)).then(_ => {
delayToProcess(delay, focusThenRemoveListeners);
});
function focusThenRemoveListeners() {
if (!manual) {
if (gotTarget !== cover)
removeListRelatedListeners();
if (addEntryListenersEachExit)
addEntryListeners();
}
onMove?.({ e, prev: list.prev, cur: null, prevI: list.prevI, curI: -1 });
focus(gotTarget);
}
}
/** 退出列表,无 target */
function exitListWithoutTarget() {
Promise.resolve(on?.(e)).then(_ => {
if (gotTarget === false) { // 如果显式设为 false,则直接退出,不聚焦,会在一个列表退出另一个列表移动的场景使用
const removeListenersWithoutFocus = focusThenRemoveListeners();
removeListenersWithoutFocus();
return ;
}
const focusTriggerThenRemoveListeners = focusThenRemoveListeners(_trigger);
delayToProcess(delay, focusTriggerThenRemoveListeners);
});
function focusThenRemoveListeners(focusTarget) {
return _ => {
if (!manual) {
removeListRelatedListeners();
if (addEntryListenersEachExit)
addEntryListeners();
}
onMove?.({ e, prev: list.prev, cur: null, prevI: list.prevI, curI: -1 });
focusTarget && focus(focusTarget);
}
}
}
}
/** 生成事件行为,添加事件监听器 */
function loadListRelatedListeners(root, listInfo, cover) {
const list = listInfo.data;
const head = listInfo.head;
const tail = listInfo.tail;
if (!listListeners.isEmpty) return ; // 列表的监听事件没有移除之前,不需要再次添加列表监听事件
if (root == null)
throw new Error(`没有找到元素 ${rootNode},您可以尝试 delayToFocus 选项,等待元素 ${rootNode} 渲染完毕后进行聚焦。`);
if (head == null || tail == null)
throw new Error("至少需要包含两个可以聚焦的元素,如果元素需要等待渲染,您可以尝试 delayToFocus 选项。");
// 添加除 trigger 以外其它和焦点相关的事件监听器
addListRelatedListeners();
/** 添加焦点需要的事件监听器 */
function addListRelatedListeners() {
/** 是否是来自默认封面出口的聚焦 */
let focusFromDefaultExitCover = false;
const useActiveIndex = () => [listInfo.curI, listInfo.recordSequenceByIdx.bind(listInfo)];
const isTrappedList = () => hasNoEntry ? true : trappedList;
// 在焦点循环中触发聚焦
const keyListMoveHandler = enabledTabSequence ? focusNextListItemBySequence : focusNextListItemByRange;
/** 出口们,列表的出口们,list 的出口们 */
const exits = getExits(exit, onEscape, enabledCover, cover, _trigger, delayToBlur);
const {
keyExits, clickExits, focusExits, hasClickExits, hasFocusExits, hasKeyExits,
clickExits_wild, focusExits_wild,
outListExits,
} = splitExits(exits, root);
/** 非跟节点内的,是根节点之外的出口 */
const clickListExitHandlers_wild = clickExits_wild.map(exit => [element(exit?.node), clickListExitHandler_wild(exit)]);
const focusListExitHandlers_wild = focusExits_wild.map(exit => [element(exit?.node), focusListExitHandler_wild(exit)]);
listListeners.push(root, "focusin", focusTrapListHandler);
listListeners.push(root, "focusout", blurTrapListHandler);
if (!root.contains(cover) && cover != null) {
listListeners.push(cover, "focus", focusTrapCoverHandler);
listListeners.push(cover, "blur", blurTrapCoverHandler);
}
listListeners.push(root, "keydown", e => {
let exited = false;
// 列表键盘出口
if (hasKeyExits)
exited = keyListExitHandler(e);
// 列表中移动,监听移动的键盘事件,例如 tab 或其它自定义组合键
if (!exited) // 退出的优先级高于列表移动
keyListMoveHandler(e);
});
listListeners.push(root, "click", e => {
// 点击聚焦列表单项,只在手动列表时监听点击,因为自动模式不需要记录 list.curI
clickListItemHandler(e);
// 列表点击出口
hasClickExits && clickListExitHandler(e);
});
// 由于 click 事件在 focus 之后,这里用来判断是否通过点击进入列表,用于纠错未知进入列表的焦点定位
listListeners.push(root, "mousedown", mousedownListItemHandler);
if (hasFocusExits) {
// 列表聚焦出口
listListeners.push(root, "focusin", focusListExitHandler);
}
// 非列表内的出口
focusListExitHandlers_wild.forEach(([node, handler]) => {
listListeners.push(node, "focus", handler);
});
clickListExitHandlers_wild.forEach(([node, handler]) => {
listListeners.push(node, "click", handler);
});
if (cover != null) {
// 封面的事件
listListeners.push(cover, "keydown", keyCoverHandler);
}
/** 是否触发了开关的 mousedown,如果是,则代表当前触发的是开关,需要忽略跳过列表的 blur 事件 */
let triggeredToggleMousedown = false;
// 若存在 outlist 类型,则为入口添加 mousedown,用于入口是开关的情况
if (outListExits) {
toggles.forEach(toggle => {
listListeners.push(toggle, "mousedown", _ => triggeredToggleMousedown = true);
});
}
// flush
listListeners.addListeners();
let isMouseDown = false;
/** 标记是否从封面进入列表,用于防止纠正列表焦点的误判,用于野生封面 */
let isEnterFromCover = false;
/*~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~+
| LIST HANDLERS |
+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~*/
function focusTrapListHandler(e) {
/** 当前焦点 */
const target = e.target;
/** 前一个焦点 */
const relatedTarget = e.relatedTarget;
// 默认封面退出
if (focusFromDefaultExitCover) {
focusFromDefaultExitCover = false;
return;
}
// 进入封面(封面在列表中)
if (enabledCover && target === cover) { // TODO: 保留确认,或是否需要添加 `&& trappedList` 条件
trappedCover = true;
return ;
}
// 纠正进入封面,从外部进入列表,如果没有通过封面,则重新聚焦封面
if (enabledCover && isMouseDown === false && trappedCover === false) {
tickFocus(cover);
return ;
}
// 调用范围模式下的 onPrev、onNext、onMove,此时焦点正在列表内移动
if (listInfo.rangeBeforePrevCallback || listInfo.rangeBeforeNextCallback) {
listInfo.recordRange(target);
listInfo.rangeBeforePrevCallback = false;
listInfo.rangeBeforeNextCallback = false;
const { cur, prev } = listInfo;
(listInfo.rangeBeforePrevCallback ? onNext : onPrev)?.({ e, prev, cur, prevI: -1, curI: -1 });
onMove?.({ e, prev, cur, prevI: -1, curI: -1 });
return ;
}
// 纠正外部聚焦进来的焦点。如果是内部的聚焦,无需纠正,防止嵌套情况的循环问题
if (correctionTarget !== false &&
trappedList === false &&
isMouseDown === false &&
(relatedTarget == null || // 上一个焦点为空
!root.contains(relatedTarget))) // 上一个焦点在根节点 root 以外的区域
{
const defaultLast = listInfo.prev || listInfo.head;
const originGotCorrectionTarget = correctionTarget?.({ list, cover, root, last: listInfo.prev, lastI: listInfo.prevI, e }) ?? defaultLast;
const gotCorrectionTarget = element(originGotCorrectionTarget);
onMoveTargetFromOuter(gotCorrectionTarget);
tickFocus(gotCorrectionTarget);
}
// 关闭焦点纠正,同时从外部进来了焦点
if (correctionTarget === false &&
trappedList === false &&
isMouseDown === false &&
(relatedTarget == null || !root.contains(relatedTarget)))
onMoveTargetFromOuter(target)
/** 矫正时的 onMove 调用 */
function onMoveTargetFromOuter(target) {
if (enabledTabSequence) { // 序列模式
const targetIndex = list.findIndex(item => item === target);
if (targetIndex > -1) {
listInfo.recordSequenceByIdx(targetIndex);
onMove?.({ e, prev: null, cur: listInfo.cur, prevI: -1, curI: listInfo.curI });
trappedList = true; // 在下一次 触发 focusin 调用 focusTrapListHandler 之前,设为 true。通过 api 调用的 focus,触发的 focusin 事件会被“同步”调用
}
} else { // 范围模式
listInfo.recordRange(target);
onMove?.({ e, prev: null, cur: listInfo.cur, prevI: -1, curI: listInfo.curI });
trappedList = true; // 在下一次 触发 focusin 调用 focusTrapListHandler 之前,设为 true。通过 api 调用的 focus,触发的 focusin 事件会被“同步”调用
}
}
}
function blurTrapListHandler(e) {
// 用于保护可切换的入口(开关,同时作为出口的入口)能够被触发;也可用 relatedTarget 判断,但 relatedTarget 不兼容 Safari(23.09.08)
if (triggeredToggleMousedown)
return triggeredToggleMousedown = false; // mousedown 一定优先 blur 触发,如果触发了 mousedown,则代表当前触发的是开关
tick(() => { // 延迟后获取下一次聚焦的元素,否则当前聚焦元素是 body
const active = getActiveElement();
const isOutRootNode = !root.contains(active);
const isActiveCover = active === cover;
// 从封面退出
if (e.target === cover && isOutRootNode) {
trappedCover = false; // 退出封面
return;
}
let isOutList = null;
if (isActiveCover || isOutRootNode) {
isOutList = outListExitHandler(e);
if (enabledTabSequence) listInfo.recordSequenceByIdx(-1);
else listInfo.recordRange(null);
}
if (isOutList === false) return; // 不符合 outlist 退出列表的条件
if (isActiveCover) { // 聚焦在封面
trappedList = false;
} else if (isOutRootNode) { // 聚焦在非封面、非列表的区域
trappedList = false;
trappedCover = false;
}
});
}
function mousedownListItemHandler(e) {
isMouseDown = true;
tick(() => isMouseDown = false); // mousedown 没有出口,只能使用定时器,isMouseDown 主要在两个 focus 事件中使用,当触发 focus 时,此定时器还未执行,以此保证正确性
let targetItem;
if (!enabledTabSequence || // 未打开 sequence 属性 或者
(enabledTabSequence && // 已打开 sequence 属性 并且
(targetItem = list.find(item => item.contains(e.target))) // 点击的目标是列表中的元素
)
) {
trappedList = true;
if (enabledCover) trappedCover = true;
// 兼容 Safari(桌面端),具体问题查看:https://github.com/wswmsword/web-experiences/tree/main/browser/safari-button-focus
if (allowSafariToFocusAfterMousedown && targetItem && window.safari !== undefined) {
focus(targetItem); // Safari 不会聚焦按钮元素,这里强制使用 api 聚焦
e.preventDefault(); // 阻止默认行为可以避免 targetItem 失焦
}
}
}
/** 点击聚焦列表某一单项 */
function clickListItemHandler(e) {
const target = e.target;
if (enabledTabSequence) { // 序列模式
const targetIndex = list.findIndex(item => item.contains(target));
if (targetIndex > -1) {
const { prev: prevBeforeRecord, prevI: prevIBeforeRecord, curI: curIBeforeRecord } = listInfo;
listInfo.recordSequenceByIdx(targetIndex);
let { prev, prevI, cur, curI } = listInfo;
if (curIBeforeRecord < 0) { // 从外部进入
if (prevIBeforeRecord !== targetIndex) { // 上一次进入 和 本次进入 的元素不同
prev = prevBeforeRecord;
prevI = prevIBeforeRecord;
}
}
onClick?.({ e, prev, cur, prevI, curI });
if (curIBeforeRecord !== curI) // 从外部进入 或者 列表内的移动
onMove?.({ e, prev, cur, prevI, curI });
}
} else { // 范围模式
const { prev: prevBeforeRecord, cur: curBeforeRecord } = listInfo;
listInfo.recordRange(target);