forked from shipshapecode/shepherd
-
Notifications
You must be signed in to change notification settings - Fork 0
/
tour.js
394 lines (331 loc) · 9.56 KB
/
tour.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
import { injectCSS } from './css';
import isEmpty from 'lodash-es/isEmpty';
import isFunction from 'lodash-es/isFunction';
import isNumber from 'lodash-es/isNumber';
import isString from 'lodash-es/isString';
import isUndefined from 'lodash-es/isUndefined';
import { Evented } from './evented.js';
import { Modal } from './modal.js';
import { Step } from './step.js';
import { bindMethods } from './bind.js';
import tippy from 'tippy.js';
import tippyStyles from 'tippy.js/dist/tippy.css';
import { defaults as tooltipDefaults } from './utils/tooltip-defaults';
import {
cleanupSteps,
cleanupStepEventListeners
} from './utils/cleanup';
import {
addStepEventListeners,
getElementForStep
} from './utils/dom';
import {
toggleShepherdModalClass
} from './utils/modal';
/**
* Creates incremented ID for each newly created tour
*
* @private
* @return {Number} The unique id for the tour
*/
const uniqueId = (function() {
let id = 0;
return function() {
return ++id;
};
})();
const Shepherd = new Evented();
/**
* Class representing the site tour
* @extends {Evented}
*/
export class Tour extends Evented {
/**
* @param {Object} options The options for the tour
* @param {Object} options.defaultStepOptions Default options for Steps created through `addStep`
* @param {Step[]} options.steps An array of Step instances to initialize the tour with
* @param {string} options.tourName An optional "name" for the tour. This will be appended to the the tour's
* dynamically generated `id` property -- which is also set on the `body` element as the `data-shepherd-active-tour` attribute
* whenever the tour becomes active.
* @param {boolean} options.useModalOverlay Whether or not steps should be placed above a darkened
* modal overlay. If true, the overlay will create an opening around the target element so that it
* can remain interactive
* @returns {Tour}
*/
constructor(options = {}) {
super(options);
bindMethods.call(this, [
'back',
'cancel',
'complete',
'hide',
'next'
]);
this.options = options;
this.steps = this.options.steps || [];
// Pass these events onto the global Shepherd object
const events = ['active', 'cancel', 'complete', 'inactive', 'show', 'start'];
events.map((event) => {
((e) => {
this.on(e, (opts) => {
opts = opts || {};
opts.tour = this;
Shepherd.trigger(e, opts);
});
})(event);
});
this.modal = new Modal(options);
this._setTooltipDefaults();
this._setTourID();
injectCSS(tippyStyles);
return this;
}
/**
* Adds a new step to the tour
* @param {Object|Number|Step|String} arg1
* When arg2 is defined, arg1 can either be a string or number, to use for the `id` for the step
* When arg2 is undefined, arg1 is either an object containing step options or a Step instance
* @param {Object|Step} arg2 An object containing step options or a Step instance
* @return {Step} The newly added step
*/
addStep(arg1, arg2) {
let name, step;
// If we just have one argument, we can assume it is an object of step options, with an id
if (isUndefined(arg2)) {
step = arg1;
} else {
name = arg1;
step = arg2;
}
if (!(step instanceof Step)) {
step = this.setupStep(step, name);
} else {
step.tour = this;
}
this.steps.push(step);
return step;
}
/**
* Go to the previous step in the tour
*/
back() {
const index = this.steps.indexOf(this.currentStep);
this.show(index - 1, false);
}
/**
* Calls done() triggering the 'cancel' event
* If `confirmCancel` is true, will show a window.confirm before cancelling
*/
cancel() {
if (this.options.confirmCancel) {
const cancelMessage = this.options.confirmCancelMessage || 'Are you sure you want to stop the tour?';
const stopTour = window.confirm(cancelMessage);
if (stopTour) {
this.done('cancel');
}
} else {
this.done('cancel');
}
}
/**
* Calls done() triggering the `complete` event
*/
complete() {
this.done('complete');
}
/**
* Called whenever the tour is cancelled or completed, basically anytime we exit the tour
* @param {String} event The event name to trigger
*/
done(event) {
if (!isEmpty(this.steps)) {
this.steps.forEach((step) => step.destroy());
}
cleanupStepEventListeners.call(this);
cleanupSteps(this.tourObject);
this.modal.cleanup();
this.trigger(event);
Shepherd.activeTour = null;
this._removeBodyAttrs();
this.trigger('inactive', { tour: this });
}
/**
* Gets the step from a given id
* @param {Number|String} id The id of the step to retrieve
* @return {Step} The step corresponding to the `id`
*/
getById(id) {
return this.steps.find((step) => {
return step.id === id;
});
}
/**
* Gets the current step
* @returns {Step|null}
*/
getCurrentStep() {
return this.currentStep;
}
/**
* Hide the current step
*/
hide() {
const currentStep = this.getCurrentStep();
if (currentStep) {
return currentStep.hide();
}
}
isActive() {
return Shepherd.activeTour === this;
}
/**
* Go to the next step in the tour
* If we are at the end, call `complete`
*/
next() {
const index = this.steps.indexOf(this.currentStep);
if (index === this.steps.length - 1) {
this.complete();
} else {
this.show(index + 1, true);
}
}
/**
* Removes the step from the tour
* @param {String} name The id for the step to remove
*/
removeStep(name) {
const current = this.getCurrentStep();
// Find the step, destroy it and remove it from this.steps
this.steps.some((step, i) => {
if (step.id === name) {
if (step.isOpen()) {
step.hide();
}
step.destroy();
this.steps.splice(i, 1);
return true;
}
});
if (current && current.id === name) {
this.currentStep = undefined;
// If we have steps left, show the first one, otherwise just cancel the tour
this.steps.length ? this.show(0) : this.cancel();
}
}
/**
* Setup a new step object
* @param {Object} stepOptions The object describing the options for the step
* @param {String|Number} name The string or number to use as the `id` for the step
* @return {Step} The step instance
*/
setupStep(stepOptions, name) {
if (isString(name) || isNumber(name)) {
stepOptions.id = name.toString();
}
stepOptions = Object.assign({}, this.options.defaultStepOptions, stepOptions);
return new Step(this, stepOptions);
}
beforeShowStep(step) {
this.modal.setupForStep(step);
this._styleTargetElementForStep(step);
}
/**
* Show a specific step in the tour
* @param {Number|String} key The key to look up the step by
* @param {Boolean} forward True if we are going forward, false if backward
*/
show(key = 0, forward = true) {
const step = isString(key) ? this.getById(key) : this.steps[key];
if (step) {
this._updateStateBeforeShow();
const shouldSkipStep = isFunction(step.options.showOn) && !step.options.showOn();
// If `showOn` returns false, we want to skip the step, otherwise, show the step like normal
if (shouldSkipStep) {
this._skipStep(step, forward);
} else {
this.trigger('show', {
step,
previous: this.currentStep
});
this.currentStep = step;
step.show();
}
}
}
/**
* Start the tour
*/
start() {
this.trigger('start');
this.currentStep = null;
this._setupActiveTour();
addStepEventListeners.call(this);
this.next();
}
/**
* Make this tour "active"
* @private
*/
_setupActiveTour() {
this._addBodyAttrs();
this.trigger('active', { tour: this });
Shepherd.activeTour = this;
}
/**
* Modulates the styles of the passed step's target element, based on the step's options and
* the tour's `modal` option, to visually emphasize the element
*
* @param step The step object that attaches to the element
* @private
*/
_styleTargetElementForStep(step) {
const targetElement = getElementForStep(step);
if (!targetElement) {
return;
}
toggleShepherdModalClass(targetElement);
if (step.options.highlightClass) {
targetElement.classList.add(step.options.highlightClass);
}
if (step.options.canClickTarget === false) {
targetElement.style.pointerEvents = 'none';
}
}
/**
* Called when `showOn` evaluates to false, to skip the step
* @param {Step} step The step to skip
* @param {Boolean} forward True if we are going forward, false if backward
* @private
*/
_skipStep(step, forward) {
const index = this.steps.indexOf(step);
const nextIndex = forward ? index + 1 : index - 1;
this.show(nextIndex, forward);
}
_setTooltipDefaults() {
tippy.setDefaults(tooltipDefaults);
}
_updateStateBeforeShow() {
if (this.currentStep) {
this.currentStep.hide();
}
if (!this.isActive()) {
this._setupActiveTour();
}
}
_setTourID() {
const tourName = this.options.tourName || 'tour';
const uuid = uniqueId();
this.id = `${tourName}--${uuid}`;
}
_addBodyAttrs() {
document.body.setAttribute('data-shepherd-active-tour', this.id);
document.body.classList.add('shepherd-active');
}
_removeBodyAttrs() {
document.body.removeAttribute('data-shepherd-active-tour');
document.body.classList.remove('shepherd-active');
}
}
export { Shepherd };