-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
465 lines (391 loc) · 13.2 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
// judge if the browser event support passive mode
let passiveSupported = false;
try {
const options = Object.defineProperty({}, 'passive', {
get: function () {
passiveSupported = true;
}
});
window.addEventListener('test', null, options);
} catch (e) {}
function isArray(arr) {
return Object.prototype.toString.call(arr) === '[object Array]';
}
function Guideline(guideOptions, callback) {
// hint text font-size setting
this.hintFontSize = 24;
this.hintTextMaxWidth = 400;
this.guideOptions = isArray(guideOptions)
? guideOptions.filter(it => typeof it === 'object' && typeof it.content === 'string' && it.content.trim().length > 0)
: [];
this.callback = callback;
this.guideElement = null;
this.cssInjected = false;
this.htmlInjected = false;
this.isGuiding = false;
this.guideIndex = -1;
this.resizeWindowHandler = this.adjustGuideHintRootElementPosition.bind(this);
this.clickHandler = this.clickHandler.bind(this);
this.keyUpHandler = this.keyboardHandler.bind(this);
}
Guideline.prototype = {
constructor: Guideline,
// start play the guideline
play: function play() {
const { length } = this.guideOptions;
if (length > 0 && !this.isGuiding) {
this.isGuiding = true;
this.guideIndex = -1;
this.injectCss();
this.injectHTML();
this.next();
}
},
// play the previous guide
prev: function prev() {
if (!this.isGuiding) return;
const currentIndex = this.guideIndex - 1;
if (currentIndex >= 0) {
this.show(currentIndex);
}
},
// play the next guide
next: function next() {
if (this.hasNext()) {
this.show(this.guideIndex + 1);
} else if (this.isGuiding) {
this.stop();
}
},
// tell if there is a follow-up
hasNext: function hasNext() {
if (!this.isGuiding) return false;
const total = this.guideOptions.length;
const nextIndex = this.guideIndex + 1;
return nextIndex >= 0 && nextIndex < total;
},
// show specific guide
show: function (guideIndex) {
const curHintOpt = this.currentHintOption = this.guideOptions[guideIndex];
if (this.guideElement) {
this.guideElement.classList.remove('guideline-current-element');
}
this.guideElement = curHintOpt.element;
if (this.guideElement) {
this.guideElement.classList.add('guideline-current-element');
}
// guide hint root element's relative position of current guide element
this.guideRelativePosition = curHintOpt.position;
if (this.guideRelativePosition !== 'bottom' && this.guideRelativePosition !== 'top') {
this.guideRelativePosition = 'bottom';
}
if (!this.guideHintRootElement) {
this.guideHintRootElement = this.guideRootElement.querySelector('.guideline-guide');
}
this.adjustGuideHintRootElementPosition();
// update hint content and style
const hintElem = this.guideHintRootElement.firstElementChild;
if (hintElem) {
hintElem.textContent = curHintOpt.content;
hintElem.style.cssText = 'style' in curHintOpt ? curHintOpt.style : '';
}
this.guideIndex = guideIndex;
},
// adjust guide content root element's position
// according to current guide element's position
adjustGuideHintRootElementPosition: function () {
if (this.guideElement) {
// hint is at the bottom of the guide element
const isBottom = this.guideRelativePosition === 'bottom';
// Making guideElement scroll into view before invoking getBoundingClientRect
// can cover the case that the guideElement's parent or grandfather has a fixed position which leads to
// guideline's height equals to window.innerHeight, in the meanwhile the guideElement's computed top is greater than window.innerHeight
// in which case the guide hint element will be outside of the screen.
if (this.guideElement.scrollIntoViewIfNeeded) {
this.guideElement.scrollIntoViewIfNeeded();
} else {
// note: some browser do not support scrollIntoViewIfNeeded() now.
this.guideElement.scrollIntoView(isBottom);
}
const {
left,
right,
top,
bottom
} = this.guideElement.getBoundingClientRect();
const winWidth = window.innerWidth;
// hint text padding
const textPadding = 10;
let hintWidth = this.calcHintTextWidth(this.hintFontSize, this.currentHintOption.content) + textPadding * 2;
hintWidth = Math.ceil(hintWidth);
if (hintWidth > this.hintTextMaxWidth) {
hintWidth = this.hintTextMaxWidth;
}
// guide element x center
const elemXCenter = (left + right) >> 1;
// calc hint text x center
let hintXCenter = elemXCenter;
if (hintXCenter + hintWidth / 2 > winWidth) {
hintXCenter = Math.floor(winWidth - hintWidth / 2);
}
if (hintXCenter - hintWidth / 2 < 0) {
hintXCenter = Math.ceil(hintWidth / 2);
}
// hint root element left coordinatee
const hintLeft = Math.floor(hintXCenter - hintWidth / 2);
// svg line coordinate
const linePos = {};
const svgInnerHeight = 50;
const svgPaddingVertical = 10; // padding: 10px 0;
const svgOuterHeight = svgInnerHeight + svgPaddingVertical * 2;
linePos.x1 = hintWidth >> 1;
linePos.x2 = elemXCenter - hintLeft;
if (isBottom) {
linePos.y1 = svgInnerHeight;
linePos.y2 = 0;
} else {
linePos.y1 = 0;
linePos.y2 = svgInnerHeight;
}
const verticalPosition = isBottom ? `top: ${bottom + 10}px` : `bottom: ${window.innerHeight - top + 10}px`;
const paddingVertical = `padding-${isBottom ? 'top' : 'bottom'}: ${svgOuterHeight}px`;
this.guideHintRootElement.style.cssText = `${paddingVertical}; left: ${hintLeft}px; width: ${hintWidth}px; ${verticalPosition};`;
// svg setting
const svg = this.guideHintRootElement.querySelector('svg');
const line = svg.querySelector('line');
svg.setAttribute('width', hintWidth);
svg.setAttribute('height', svgOuterHeight);
if (isBottom) {
svg.style.top = 0;
svg.style.bottom = 'auto';
} else {
svg.style.top = 'auto';
svg.style.bottom = 0;
}
Object.keys(linePos).forEach((attr) => {
line.setAttribute(attr, linePos[attr]);
});
} else {
this.guideHintRootElement.style.cssText = `left: 50%; top: 50%; transform: translate(-50%, -50%);`;
const svg = this.guideHintRootElement.querySelector('svg');
svg.setAttribute('width', 0);
svg.setAttribute('height', 0);
}
},
// calculate the layout width of hint text
calcHintTextWidth: function (fontSize, text) {
const span = document.createElement('span');
span.style.position = 'absolute';
span.style.left = '-10000px';
span.style.bottom = 0;
span.style.display = 'inline-block';
span.style.visibility = 'hidden';
span.style.fontSize = fontSize + 'px';
span.innerText = text;
document.body.appendChild(span);
const rect = span.getBoundingClientRect();
document.body.removeChild(span);
return rect.width;
},
// inject css into document's head
injectCss: function injectCss() {
if (this.cssInjected) {
return;
}
const cssId = 'guideline-css-style';
let elem = document.getElementById(cssId);
if (!elem) {
elem = document.createElement('style');
elem.setAttribute('type', 'text/css');
elem.id = cssId;
const cssText = `
.guideline-current-element {
position: relative;
z-index: 9991;
box-shadow: 0 0 4px 4px rgba(255, 0, 0, 0.8);
animation: breathe 2s ease 1s infinite;
}
.body-with-guideline {
overflow: hidden;
height: 100%;
}
.guideline-wrapper,
.guideline-bg,
.guideline-mask {
position: fixed;
top: 0;
left: 0;
right: 0;
bottom: 0;
}
.guideline-wrapper {
transition: opacity 0.5s ease;
opacity: 0;
}
.guideline-wrapper.show {
opacity: 1;
}
.guideline-bg {
background: hsla(0, 0%, 0%, 0.6);
z-index: 9990;
}
.guideline-mask {
z-index: 9992;
}
.guideline-guide {
position: absolute;
color: hsl(0, 0%, 100%);
font-size: ${this.hintFontSize}px;
z-index: 9993;
}
.guideline-guide > .guideline-hint {
display: inline-block;
padding: 10px;
line-height: 1.25;
text-shadow: 0 0 20px currentColor;
}
@keyframes breathe {
from {
box-shadow: 0 0 4px 4px rgba(255, 0, 0, 0.8);
}
50% {
box-shadow: 0 0 2px 1px rgba(255, 0, 0, 0.6);
}
to {
box-shadow: 0 0 4px 4px rgba(255, 0, 0, 0.8);
}
}
`;
// ie8 及之前版本不支持,可使用 cssText 兼容
elem.textContent = cssText;
document.head.appendChild(elem);
}
this.cssInjected = true;
},
// remove css from document's head
unloadCss: function unloadCss() {
if (this.cssInjected) {
const css = document.getElementById('guideline-css-style');
css.parentNode.removeChild(css);
}
},
// inject guide html fragment into document's body
injectHTML: function injectHTML() {
if (this.htmlInjected) {
return;
}
// if there already exists a guideline-wrapper, throw error
if (document.querySelector('.guideline-wrapper')) {
throw new Error('A guideline already exists, it\'s not allowed to run another guideline until the previous one finishes');
}
this.htmlInjected = true;
const html = `
<div class="guideline-wrapper show">
<div class="guideline-bg"></div>
<div class="guideline-mask"></div>
<div class="guideline-guide">
<span class="guideline-hint"></span>
<svg width="0" height="0" style="padding: 10px 0; position: absolute; left: 0; box-sizing: border-box;">
<defs>
<marker id="arrow" viewBox="0 0 12 12" refX="10" refY="6" markerWidth="6" markerHeight="20" orient="auto" style="fill: currentColor;">
<path d="M 0 0 L 12 6 L 0 12 z" />
</marker>
</defs>
<line x1="0" y1="0" x2="100" y2="100" style="stroke:currentColor;stroke-width:2" marker-end="url(#arrow)"/>
</svg>
</div>
</div>
`;
document.body.insertAdjacentHTML('beforeend', html);
// 阻止 body 滚动
document.body.classList.add('body-with-guideline');
this.guideRootElement = document.querySelector('.guideline-wrapper');
// bind click listener
this.guideRootElement.addEventListener('click', this.clickHandler, passiveSupported ? { passive: true } : false);
// bind keyboard event listener
window.addEventListener('keyup', this.keyUpHandler, true);
// listen window resize event
window.addEventListener('resize', this.resizeWindowHandler, passiveSupported ? { passive: true } : false);
},
// remove guide html fragment from document's body
unloadHTML: function unloadHTML() {
if (!this.htmlInjected) {
return;
}
this.htmlInjected = false;
document.body.classList.remove('body-with-guideline');
if (this.guideRootElement) {
this.guideRootElement.parentNode.removeChild(this.guideRootElement);
this.guideRootElement = null;
}
// removeEventListener or detachEvent
// http://www.runoob.com/jsref/met-element-removeeventlistener.html
// useCapture 是否必须分情况而定
//
// bind keyboard event listener
window.removeEventListener('keyup', this.keyUpHandler);
// unbind window resize listener
window.removeEventListener('resize', this.resizeWindowHandler);
},
// handle click event to navigate guideline
clickHandler: function clickHandler(e) {
e.stopPropagation();
this.next();
},
// handle keyboard event
keyboardHandler: function keyboardHandler(e) {
if (e.ctrlKey || e.altKey || e.shiftKey || e.metaKey) {
// 组合键,不是要控制功能指引的前进后退
return;
}
switch (e.keyCode || e.which) {
// arrow right
case 39:
// enter
case 13:
// space
case 32:
this.next();
break;
// arrow left
case 37:
// backspace
case 8:
this.prev();
break;
// esc
case 27:
this.stop();
break;
default:
}
},
// stop play the guideline
stop: function stop() {
if (this.isGuiding) {
this.isGuiding = false;
const total = this.guideOptions.length;
const playLength = this.guideIndex + 1;
this.guideIndex = -1;
this.destroy();
if (this.callback && typeof this.callback === 'function') {
this.callback(total, playLength);
}
}
},
destroy: function destroy() {
this.guideOptions = null;
if (this.guideElement) {
this.guideElement.classList.remove('guideline-current-element');
this.guideElement = null;
}
this.unloadHTML();
this.unloadCss();
}
};
function guide(guideOptions, callback) {
const gl = new Guideline(guideOptions, callback);
gl.play();
};
guide.Guideline = Guideline;
module.exports = guide;