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
|
/*
* Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/**
* This class is used to control the document focus when a non-body element contains the main scrollbar.
* Web browsers will not automatically focus a custom element with the scrollbar on load, which results in
* keyboard shortcuts (e.g. arrow keys) not controlling page scroll. Instead, this class will manually
* focus a dummy element inside the main content, which gives keyboard scroll focus to that element.
*/
export class DocumentFocusController {
/**
* Creates a new instance of the class.
* @param {?string} autofocusElementSelector A selector string which can be used to specify an element which
* should be automatically focused on prepare.
*/
constructor(autofocusElementSelector = null) {
/** @type {?HTMLElement} */
this._autofocusElement = (autofocusElementSelector !== null ? document.querySelector(autofocusElementSelector) : null);
/** @type {?HTMLElement} */
this._contentScrollFocusElement = document.querySelector('#content-scroll-focus');
}
/**
* Initializes the instance.
*/
prepare() {
window.addEventListener('focus', this._onWindowFocus.bind(this), false);
this._updateFocusedElement(false);
if (this._autofocusElement !== null && document.activeElement !== this._autofocusElement) {
this._autofocusElement.focus({preventScroll: true});
}
}
/**
* Removes focus from a given element.
* @param {HTMLElement} element The element to remove focus from.
*/
blurElement(element) {
if (document.activeElement !== element) { return; }
element.blur();
this._updateFocusedElement(false);
}
// Private
/** */
_onWindowFocus() {
this._updateFocusedElement(false);
}
/**
* @param {boolean} force
*/
_updateFocusedElement(force) {
const target = this._contentScrollFocusElement;
if (target === null) { return; }
const {activeElement} = document;
if (
force ||
activeElement === null ||
activeElement === document.documentElement ||
activeElement === document.body
) {
// Get selection
const selection = window.getSelection();
if (selection === null) { return; }
const selectionRanges1 = this._getSelectionRanges(selection);
// Note: This function will cause any selected text to be deselected on Firefox.
target.focus({preventScroll: true});
// Restore selection
const selectionRanges2 = this._getSelectionRanges(selection);
if (!this._areRangesSame(selectionRanges1, selectionRanges2)) {
this._setSelectionRanges(selection, selectionRanges1);
}
}
}
/**
* @param {Selection} selection
* @returns {Range[]}
*/
_getSelectionRanges(selection) {
const ranges = [];
for (let i = 0, ii = selection.rangeCount; i < ii; ++i) {
ranges.push(selection.getRangeAt(i));
}
return ranges;
}
/**
* @param {Selection} selection
* @param {Range[]} ranges
*/
_setSelectionRanges(selection, ranges) {
selection.removeAllRanges();
for (const range of ranges) {
selection.addRange(range);
}
}
/**
* @param {Range[]} ranges1
* @param {Range[]} ranges2
* @returns {boolean}
*/
_areRangesSame(ranges1, ranges2) {
const ii = ranges1.length;
if (ii !== ranges2.length) {
return false;
}
for (let i = 0; i < ii; ++i) {
const range1 = ranges1[i];
const range2 = ranges2[i];
try {
if (
range1.compareBoundaryPoints(Range.START_TO_START, range2) !== 0 ||
range1.compareBoundaryPoints(Range.END_TO_END, range2) !== 0
) {
return false;
}
} catch (e) {
return false;
}
}
return true;
}
}
|