forked from IGreatlyDislikeJavascript/bootstrap-tourist
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbootstrap-tourist.js
executable file
·2345 lines (2047 loc) · 82.2 KB
/
bootstrap-tourist.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
/* ========================================================================
*
* Bootstrap Tourist v0.3.3-in progress
* Copyright FFS 2019
* @ IGreatlyDislikeJavascript on Github
*
* This code is a fork of bootstrap-tour, with a lot of extra features
* and fixes. You can read about why this fork exists here:
*
* https://github.com/sorich87/bootstrap-tour/issues/713
*
* The entire purpose of this fork is to start rewriting bootstrap-tour
* into native ES6 instead of the original coffeescript, and to implement
* the features and fixes requested.
*
* I'm not a JS coder, so suggest you test very carefully and read the
* docs before using.
*
* ========================================================================
* ENTIRELY BASED UPON:
*
* bootstrap-tour
* http://bootstraptour.com
* Copyright 2012-2015 Ulrich Sossou
*
* ========================================================================
* Licensed under the MIT License (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://opensource.org/licenses/MIT
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ========================================================================
*/
(function (window, factory) {
if (typeof define === 'function' && define.amd) {
return define(['jquery'], function (jQuery) {
return window.Tour = factory(jQuery);
});
} else if (typeof exports === 'object') {
return module.exports = factory(require('jquery'));
} else {
return window.Tour = factory(window.jQuery);
}
})(window, function ($) {
const DOMID_BACKDROP = "#tourBackdrop";
const DOMID_BACKDROP_TEMP = "#tourBackdrop-temp"; // used for @ibastevan zindex fix: https://github.com/IGreatlyDislikeJavascript/bootstrap-tourist/issues/38
const DOMID_HIGHLIGHT = "#tourHighlight";
const DOMID_HIGHLIGHT_TEMP = "#tourHighlight-temp"; // used for @ibastevan zindex fix: https://github.com/IGreatlyDislikeJavascript/bootstrap-tourist/issues/38
const DOMID_PREVENT = "#tourPrevent";
var Tour, document, objTemplates, objTemplatesButtonTexts;
document = window.document;
Tour = (function () {
function Tour(options)
{
var storage;
try
{
storage = window.localStorage;
}
catch (error)
{
storage = false;
}
// CUSTOMIZABLE TEXTS FOR BUTTONS
// set defaults. We could of course add this to the $.extend({..localization: {} ...}) directly below.
// However this is configured here, prior to the $.extend of options below, to enable a potential
// future option of loading localization externally perhaps using $.getScript() etc.
//
// Note that these only affect the "default" templates (see objTemplates in this func below). The assumption is
// that if user creates a tour with a custom template, they will name the buttons as required. We could force the
// naming even in custom templates by identifying buttons in templates with data-role="...", but it seems more logical
// NOT to do that...
//
// Finally, it's simple to allow different localization/button texts per tour step. To do this, alter the $.extend in
// Tour.prototype.getStep() and subsequent code to load the per-step localization, identify the buttons by data-role, and
// make the appropriate changes. That seems like a very niche requirement so it's not implemented here.
objTemplatesButtonTexts = {
prevButton: "Prev",
nextButton: "Next",
pauseButton: "Pause",
resumeButton: "Resume",
endTourButton: "End Tour"
};
// GLOBAL OPTIONS take default options and overwrite with this tour options
this._options = $.extend(true,
{
name: 'tour',
steps: [],
container: 'body',
autoscroll: false,
keyboard: true,
storage: storage,
debug: false,
backdrop: false,
backdropContainer: 'body',
backdropOptions: {
highlightOpacity: 0.9,
highlightColor: "#FFF",
backdropSibling: false,
animation: {
// can be string of css class or function signature: function(domElement, step) {}
backdropShow: function(domElement, step)
{
domElement.fadeIn();
},
backdropHide: function(domElement, step)
{
domElement.fadeOut("slow")
},
highlightShow: function(domElement, step)
{
// calling step.fnPositionHighlight() is the same as:
// domElement.width($(step.element).outerWidth()).height($(step.element).outerHeight()).offset($(step.element).offset());
step.fnPositionHighlight();
domElement.fadeIn();
},
highlightTransition: "tour-highlight-animation",
highlightHide: function(domElement, step)
{
domElement.fadeOut("slow")
}
},
},
redirect: true,
orphan: false,
showIfUnintendedOrphan: false,
duration: false,
delay: false,
basePath: '',
template: null,
localization: {
buttonTexts: objTemplatesButtonTexts
},
framework: 'bootstrap3',
sanitizeWhitelist: [],
sanitizeFunction: null,// function(content) return sanitizedContent
showProgressBar: true,
showProgressText: true,
getProgressBarHTML: null,//function(percent) {},
getProgressTextHTML: null,//function(stepNumber, percent, stepCount) {},
afterSetState: function (key, value) {},
afterGetState: function (key, value) {},
afterRemoveState: function (key) {},
onStart: function (tour) {},
onEnd: function (tour) {},
onShow: function (tour) {},
onShown: function (tour) {},
onHide: function (tour) {},
onHidden: function (tour) {},
onNext: function (tour) {},
onPrev: function (tour) {},
onPause: function (tour, duration) {},
onResume: function (tour, duration) {},
onRedirectError: function (tour) {},
onElementUnavailable: null, // function (tour, stepNumber) {},
onPreviouslyEnded: null, // function (tour) {},
onModalHidden: null, // function(tour, stepNumber) {}
}, options);
if($(this._options.backdropContainer).length == 0)
{
this._options.backdropContainer = "body";
}
if(this._options.framework !== "bootstrap3" && this._options.framework !== "bootstrap4" && this._options.framework !== "bootstrap5")
{
this._debug('Invalid framework specified: ' + this._options.framework);
throw "Bootstrap Tourist: Invalid framework specified";
}
// create the templates
// SEARCH PLACEHOLDER: TEMPLATES LOCATION
objTemplates = {
bootstrap3 : '<div class="popover" role="tooltip"> <div class="arrow"></div> <h3 class="popover-title"></h3> <div class="popover-content"></div> <div class="popover-navigation"> <div class="btn-group"> <button class="btn btn-sm btn-default" data-role="prev">« ' + this._options.localization.buttonTexts.prevButton + '</button> <button class="btn btn-sm btn-default" data-role="next">' + this._options.localization.buttonTexts.nextButton + ' »</button> <button class="btn btn-sm btn-default" data-role="pause-resume" data-pause-text="' + this._options.localization.buttonTexts.pauseButton + '" data-resume-text="' + this._options.localization.buttonTexts.resumeButton + '">' + this._options.localization.buttonTexts.pauseButton + '</button> </div> <button class="btn btn-sm btn-default" data-role="end">' + this._options.localization.buttonTexts.endTourButton + '</button> </div> </div>',
bootstrap4 : '<div class="popover" role="tooltip"> <div class="arrow"></div> <h3 class="popover-header"></h3> <div class="popover-body"></div> <div class="popover-navigation"> <div class="btn-group"> <button class="btn btn-sm btn-outline-secondary" data-role="prev">« ' + this._options.localization.buttonTexts.prevButton + '</button> <button class="btn btn-sm btn-outline-secondary" data-role="next">' + this._options.localization.buttonTexts.nextButton + ' »</button> <button class="btn btn-sm btn-outline-secondary" data-role="pause-resume" data-pause-text="' + this._options.localization.buttonTexts.pauseButton + '" data-resume-text="' + this._options.localization.buttonTexts.resumeButton + '">' + this._options.localization.buttonTexts.pauseButton + '</button> </div> <button class="btn btn-sm btn-outline-secondary" data-role="end">' + this._options.localization.buttonTexts.endTourButton + '</button> </div> </div>',
bootstrap5 : '<div class="popover" role="tooltip"> <div class="arrow"></div> <h3 class="popover-header"></h3> <div class="popover-body"></div> <div class="popover-navigation"> <div class="btn-group"> <button class="btn btn-sm btn-outline-secondary" data-role="prev">« ' + this._options.localization.buttonTexts.prevButton + '</button> <button class="btn btn-sm btn-outline-secondary" data-role="next">' + this._options.localization.buttonTexts.nextButton + ' »</button> <button class="btn btn-sm btn-outline-secondary" data-role="pause-resume" data-pause-text="' + this._options.localization.buttonTexts.pauseButton + '" data-resume-text="' + this._options.localization.buttonTexts.resumeButton + '">' + this._options.localization.buttonTexts.pauseButton + '</button> </div> <button class="btn btn-sm btn-outline-secondary" data-role="end">' + this._options.localization.buttonTexts.endTourButton + '</button> </div> </div>'
};
// template option is default null. If not null after extend, caller has set a custom template, so don't touch it
if(this._options.template === null)
{
// no custom template, so choose the template based on the framework
if(objTemplates[this._options.framework] != null && objTemplates[this._options.framework] != undefined)
{
// there's a default template for the framework type specified in the options
this._options.template = objTemplates[this._options.framework];
this._debug('Using framework template: ' + this._options.framework);
}
else
{
this._debug('Warning: ' + this._options.framework + ' specified for template (no template option set), but framework is unknown. Tour will not work!');
}
}
else
{
this._debug('Using custom template');
}
if(typeof(this._options.sanitizeFunction) == "function")
{
this._debug("Using custom sanitize function in place of bootstrap - security implications, be careful");
}
else
{
this._options.sanitizeFunction = null;
this._debug("Extending Bootstrap sanitize options");
// no custom function, add our own
// bootstrap 3.4.1 has whitelist functionality that strips tags from title, content etc of popovers and tooltips. Need to
// add buttons to the whitelist otherwise the navigation buttons will be stripped from the popover content.
// See issue: https://github.com/sorich87/bootstrap-tour/issues/723#issuecomment-471107788
//
// ** UPDATE: BS3 and BS4 have the whitelist function. However:
// BS3 uses $.fn.popover.Constructor.DEFAULTS.whiteList
// BS4 uses $.fn.popover.Constructor.Default.whiteList
// Even better, the CDN version of BS4 doesn't seem to include a whitelist property at all, which utterly screwed the first attempt at implementing
// this, making it seem like my fix was working when in fact it was utterly broken.
var defaultWhiteList = [];
if((this._options.framework == "bootstrap4") && $.fn.popover.Constructor.Default.whiteList !== undefined)
{
defaultWhiteList = $.fn.popover.Constructor.Default.whiteList;
}
if((this._options.framework == "bootstrap4") && $.fn.popover.Constructor.Default.whiteList !== undefined)
{
defaultWhiteList = bootstrap.Popover.Default.allowList;
}
var whiteListAdditions = {
"button": ["data-role", "style"],
"img": ["style"],
"div": ["style"]
};
// whitelist is object with properties that are arrays. Need to merge "manually", as using $.extend with recursion will still overwrite the arrays . Try
// var whiteList = $.extend(true, {}, defaultWhiteList, whiteListAdditions, this._options.sanitizeWhitelist);
// and inspect the img property to see the issue - the default whitelist "src" (array elem 0) is overwritten with additions "style"
// clone the default whitelist object first, otherwise we change the defaults for all of bootstrap!
var whiteList = $.extend(true, {}, defaultWhiteList);
// iterate the additions, and merge them into the defaults. We could just hammer them in manually but this is a little more expandable for the future
$.each(whiteListAdditions, function( index, value )
{
if(whiteList[index] == undefined)
{
whiteList[index] = [];
}
$.merge(whiteList[index], value);
});
// and now do the same with the user specified whitelist in tour options
$.each(this._options.sanitizeWhitelist, function( index, value )
{
if(whiteList[index] == undefined)
{
whiteList[index] = [];
}
$.merge(whiteList[index], value);
});
// save the merged whitelist back to the options, this is used by popover initialization when each step is shown
this._options.sanitizeWhitelist = whiteList;
}
this._current = null;
this.backdrops = [];
return this;
}
Tour.prototype.addSteps = function (steps) {
var j,
len,
step;
for (j = 0, len = steps.length; j < len; j++) {
step = steps[j];
this.addStep(step);
}
return this;
};
Tour.prototype.addStep = function (step) {
this._options.steps.push(step);
return this;
};
Tour.prototype.getStepCount = function() {
return this._options.steps.length;
};
Tour.prototype.getStep = function (i) {
if (this._options.steps[i] != null) {
if(typeof(this._options.steps[i].element) == "function")
{
this._options.steps[i].element = this._options.steps[i].element();
}
// PER STEP OPTIONS: take the global options then override with this step's options.
this._options.steps[i] = $.extend(true,
{
id: "step-" + i,
path: '',
host: '',
placement: 'right',
positioning:{
adjustRelative: null // this does nothing at the moment
},
title: '',
content: '<p></p>',
next: i === this._options.steps.length - 1 ? -1 : i + 1,
prev: i - 1,
animation: true,
container: this._options.container,
autoscroll: this._options.autoscroll,
backdrop: this._options.backdrop,
//backdropOptions: this._options.backdropOptions, << SEE BELOW
redirect: this._options.redirect,
preventInteraction: false,
orphan: this._options.orphan,
showIfUnintendedOrphan: this._options.showIfUnintendedOrphan,
duration: this._options.duration,
delay: this._options.delay,
delayOnElement: null,
template: this._options.template,
showProgressBar: this._options.showProgressBar,
showProgressText: this._options.showProgressText,
getProgressBarHTML: this._options.getProgressBarHTML,
getProgressTextHTML: this._options.getProgressTextHTML,
onShow: this._options.onShow,
onShown: this._options.onShown,
onHide: this._options.onHide,
onHidden: this._options.onHidden,
onNext: this._options.onNext,
onPrev: this._options.onPrev,
onPause: this._options.onPause,
onResume: this._options.onResume,
onRedirectError: this._options.onRedirectError,
onElementUnavailable: this._options.onElementUnavailable,
onModalHidden: this._options.onModalHidden,
internalFlags: {
elementModal: null, // will store the jq modal object for a step
elementModalOriginal: null, // will store the original step.element string in steps that use a modal
elementBootstrapSelectpicker: null // will store jq bootstrap select picker object
}
},
this._options.steps[i]
);
// required so we don't overwrite the global options.
this._options.steps[i].backdropOptions = $.extend(true, {}, this._options.backdropOptions, this._options.steps[i].backdropOptions);
// safety to ensure consistent logic - reflex must == true if reflexOnly == true
if(this._options.steps[i].reflexOnly == true)
{
this._options.steps[i].reflex = true;
}
return this._options.steps[i];
}
};
// step flags are used to remember specific internal step data across a tour
Tour.prototype._setStepFlag = function(stepNumber, flagName, value)
{
if(this._options.steps[stepNumber] != null)
{
this._options.steps[stepNumber].internalFlags[flagName] = value;
}
};
Tour.prototype._getStepFlag = function(stepNumber, flagName)
{
if(this._options.steps[stepNumber] != null)
{
return this._options.steps[stepNumber].internalFlags[flagName];
}
};
//=======================================================================================================================================
// Initiate tour and movement between steps
Tour.prototype.init = function ()
{
console.log('You should remove Tour.init() from your code. It\'s not required with Bootstrap Tourist');
}
Tour.prototype.start = function ()
{
// Test if this tour has previously ended, and start() was called
if(this.ended())
{
if(this._options.onPreviouslyEnded != null && typeof(this._options.onPreviouslyEnded) == "function")
{
this._debug('Tour previously ended, exiting. Call tour.restart() to force restart. Firing onPreviouslyEnded()');
this._options.onPreviouslyEnded(this);
}
else
{
this._debug('Tour previously ended, exiting. Call tour.restart() to force restart');
}
return this;
}
// Call setCurrentStep() without params to start the tour using whatever step is recorded in localstorage. If no step recorded, tour starts
// from first step. This provides the "resume tour" functionality.
// Tour restart() simply removes the step from local storage
this.setCurrentStep();
// Create the backdrop and highlight divs
this._createOverlayElements();
this._initMouseNavigation();
this._initKeyboardNavigation();
// BS3: resize event must destroy and recreate both popper and background to ensure correct positioning
// BS4: resize must destroy and recreate background, but popper.js handles popper positioning.
var _this = this;
$(window).on("resize.tour-" + _this._options.name, function()
{
_this.reshowCurrentStep();
}
);
// Note: this call is not required, but remains here in case any future forkers want to reinstate the code that moves a non-orphan popover
// when window is scrolled. Note that simply uncommenting this will not reinstate the code - _showPopoverAndOverlay automatically detects
// if the current step is visible and will not reshow it. Therefore, to fully reinstate the "redraw on scroll" code, uncomment this and
// also add appropriate code (to move popover & overlay) to the end of showPopover()
// this._onScroll((function (_this)
// {
// return function ()
// {
// return _this._showPopoverAndOverlay(_this._current);
// };
// }
// ));
// start the tour - see if user provided onStart function, and if it returns a promise, obey that promise before calling showStep
var promise = this._makePromise(this._options.onStart != null ? this._options.onStart(this) : void 0);
this._callOnPromiseDone(promise, this.showStep, this._current);
return this;
};
Tour.prototype.next = function () {
var promise;
promise = this.hideStep();
return this._callOnPromiseDone(promise, this._showNextStep);
};
Tour.prototype.prev = function () {
var promise;
promise = this.hideStep();
return this._callOnPromiseDone(promise, this._showPrevStep);
};
Tour.prototype.goTo = function (i) {
var promise;
this._debug("goTo step " + i);
promise = this.hideStep();
return this._callOnPromiseDone(promise, this.showStep, i);
};
Tour.prototype.end = function ()
{
this._debug("Tour.end() called");
var endHelper,
promise;
endHelper = (function (_this) {
return function (e) {
this._debug("endHelper run");
$(document).off("click.tour-" + _this._options.name);
$(document).off("keyup.tour-" + _this._options.name);
$(window).off("resize.tour-" + _this._options.name);
$(window).off("scroll.tour-" + _this._options.name);
_this._setState('end', 'yes');
_this._clearTimer();
$(".tour-step-element-reflex").removeClass("tour-step-element-reflex");
$(".tour-step-element-reflexOnly").removeClass("tour-step-element-reflexOnly");
_this._hideBackdrop();
_this._destroyOverlayElements();
$(".tour-tour").remove();
if (_this._options.onEnd != null)
{
return _this._options.onEnd(_this);
}
};
})(this);
promise = this.hideStep();
return this._callOnPromiseDone(promise, endHelper);
};
Tour.prototype.ended = function () {
return this._getState('end') == 'yes';
};
Tour.prototype.restart = function ()
{
this._removeState('current_step');
this._removeState('end');
this._removeState('redirect_to');
return this.start();
};
Tour.prototype.pause = function () {
var step;
step = this.getStep(this._current);
if (!(step && step.duration)) {
return this;
}
this._paused = true;
this._duration -= new Date().getTime() - this._start;
window.clearTimeout(this._timer);
this._debug("Paused/Stopped step " + (this._current + 1) + " timer (" + this._duration + " remaining).");
if (step.onPause != null) {
return step.onPause(this, this._duration);
}
};
Tour.prototype.resume = function () {
var step;
step = this.getStep(this._current);
if (!(step && step.duration)) {
return this;
}
this._paused = false;
this._start = new Date().getTime();
this._duration = this._duration || step.duration;
this._timer = window.setTimeout(( function (_this)
{
return function ()
{
if (_this._isLast())
{
return _this.end();
}
else
{
return _this.next();
}
};
})(this), this._duration);
this._debug("Started step " + (this._current + 1) + " timer with duration " + this._duration);
if ((step.onResume != null) && this._duration !== step.duration) {
return step.onResume(this, this._duration);
}
};
// fully closes and reopens the current step, triggering all callbacks etc
Tour.prototype.reshowCurrentStep = function()
{
this._debug("Reshowing current step " + this.getCurrentStepIndex());
var promise;
promise = this.hideStep();
return this._callOnPromiseDone(promise, this.showStep, this._current);
};
//=======================================================================================================================================
// hides current step
Tour.prototype.hideStep = function ()
{
var hideDelay,
hideStepHelper,
promise,
step;
step = this.getStep(this.getCurrentStepIndex());
if (!step)
{
return;
}
this._clearTimer();
promise = this._makePromise(step.onHide != null ? step.onHide(this, this.getCurrentStepIndex()) : void 0);
hideStepHelper = (function (_this)
{
return function (e)
{
var $element;
this._debug('hideStepHelper run')
$element = $(step.element);
var bootstrapPopover = bootstrap.Popover.getInstance($element.get(0));
if (!bootstrapPopover) {
$element = $('body');
}
if(_this._options.framework == "bootstrap3")
{
$element.popover('destroy');
}
if(_this._options.framework == "bootstrap4" || _this._options.framework == "bootstrap5")
{
this._debug('element dispose')
$element.popover('dispose');
}
$element.removeClass("tour-" + _this._options.name + "-element tour-" + _this._options.name + "-" + _this.getCurrentStepIndex() + "-element").removeData('bs.popover');
if (step.reflex)
{
$element.removeClass('tour-step-element-reflex').off((_this._reflexEvent(step.reflex)) + ".tour-" + _this._options.name);
$element.removeClass('tour-step-element-reflexOnly');
}
// now handled by updateOverlayElements
//_this._hideOverlayElements(step);
_this._unfixBootstrapSelectPickerZindex(step);
// If this step was pointed at a modal, revert changes to the step.element. See the notes in showStep for explanation
var tmpModalOriginalElement = _this._getStepFlag(_this.getCurrentStepIndex(), "elementModalOriginal");
if(tmpModalOriginalElement != null)
{
_this._setStepFlag(_this.getCurrentStepIndex(), "elementModalOriginal", null);
step.element = tmpModalOriginalElement;
}
if (step.onHidden != null)
{
return step.onHidden(_this);
}
};
})(this);
hideDelay = step.delay.hide || step.delay;
this._debug('hideDay: ' + hideDelay)
if ({}
.toString.call(hideDelay) === '[object Number]' && hideDelay > 0) {
this._debug("Wait " + hideDelay + " milliseconds to hide the step " + (this._current + 1));
window.setTimeout((function (_this) {
return function () {
return _this._callOnPromiseDone(promise, hideStepHelper);
};
})(this), hideDelay);
} else {
this._callOnPromiseDone(promise, hideStepHelper);
}
return promise;
};
// loads all required step info and prepares to show
Tour.prototype.showStep = function (i) {
var path,
promise,
showDelay,
showStepHelper,
skipToPrevious,
step,
$element;
if(this.ended())
{
// Note: see feature addition #12 and "onPreviouslyEnded" option to understand when this._options.onEnd is called vs this._options.onPreviouslyEnded()
this._debug('Tour ended, showStep prevented.');
if(this._options.onEnd != null)
{
this._options.onEnd(this);
}
return this;
}
step = this.getStep(i);
if (!step) {
return;
}
skipToPrevious = i < this._current;
promise = this._makePromise(step.onShow != null ? step.onShow(this, i) : void 0);
this.setCurrentStep(i);
path = (function () {
switch ({}
.toString.call(step.path)) {
case '[object Function]':
return step.path();
case '[object String]':
return this._options.basePath + step.path;
default:
return step.path;
}
}).call(this);
if (step.redirect && this._isRedirect(step.host, path, document.location)) {
this._redirect(step, i, path);
if (!this._isJustPathHashDifferent(step.host, path, document.location)) {
return;
}
}
// will be set to element <div class="modal"> if modal in use
var $modalObject = null;
// is element a modal?
if(step.orphan === false && ($(step.element).hasClass("modal") || $(step.element).data('bs.modal')))
{
// element is exactly the modal div
$modalObject = $(step.element);
// This is a hack solution. Original Tour uses step.element in multiple places and converts to jquery object as needed. This func uses $element,
// but multiple other funcs simply use $(step.element) instead - keeping the original string element id in the step data and using jquery as needed.
// This creates problems with dialogs, especially BootStrap Dialog plugin - in code terms, the dialog is everything from <div class="modal-dialog">,
// but the actual visible positioned part of the dialog is <div class="modal-dialog"><div class="modal-content">. The tour must attach the popover to
// modal-content div, NOT the modal-dialog div. But most coders + dialog plugins put the id on the modal-dialog div.
// So for display, we must adjust the step element to point at modal-content under the modal-dialog div. However if we change the step.element
// permanently to the modal-content (by changing tour._options.steps), this won't work if the step is reshown (plugin destroys modal, meaning
// the element jq object is no longer valid) and could potentially screw up other
// parts of a tour that have dialogs. So instead we record the original element used for this step that involves modals, change the step.element
// to the modal-content div, then set it back when the step is hidden again.
//
// This is ONLY done because it's too difficult to unpick all the original tour code that uses step.element directly.
this._setStepFlag(this.getCurrentStepIndex(), "elementModalOriginal", step.element);
// fix the tour element, the actual visible offset comes from modal > modal-dialog > modal-content and step.element is used to calc this offset & size
step.element = $(step.element).find(".modal-content:first");
}
$element = $(step.element);
// is element inside a modal? Find the parent modal
if($modalObject === null && $element.parents(".modal:first").length)
{
// find the parent modal div
$modalObject = $element.parents(".modal:first");
}
// Is this step a modal?
if($modalObject && $modalObject.length > 0)
{
// Yes, set up the modal helper - called when the modal is hidden. This enables the onModalHidden tour option.
this._debug("Modal identified, onModalHidden callback available");
// store the modal element for other calls
this._setStepFlag(i, "elementModal", $modalObject)
// modal in use, add callback
var funcModalHelper = function(_this, $_modalObject)
{
return function ()
{
_this._debug("Modal close triggered");
if(typeof(step.onModalHidden) == "function")
{
// if step onModalHidden returns false, do nothing. returns int, move to the step specified.
// Otherwise continue regular next/end functionality
var rslt = step.onModalHidden(_this, i);
if(rslt === false)
{
_this._debug("onModalHidden returned exactly false, tour step unchanged");
return;
}
if(Number.isInteger(rslt))
{
_this._debug("onModalHidden returned int, tour moving to step " + rslt + 1);
$_modalObject.off("hidden.bs.modal", funcModalHelper);
return _this.goTo(rslt);
}
_this._debug("onModalHidden did not return false or int, continuing tour");
}
$_modalObject.off("hidden.bs.modal", funcModalHelper);
// thanks to @eformx for finding this bug!
if (_this._isLast())
{
_this._debug("Modal close reached end of tour");
return _this.end();
}
else
{
_this._debug("Modal close: next step called");
return _this.next();
}
};
}(this, $modalObject);
$modalObject.off("hidden.bs.modal", funcModalHelper).on("hidden.bs.modal", funcModalHelper);
}
// Helper function to actually show the popover using _showPopoverAndOverlay.
// Note the flow - this is called immediately unless delayOnElement is set. If delayOnElement is set, this
// func will be called if (a) the element appears, or (b) the element doesn't appear in the timeout.
// Therefore this helper func MUST handle unintended orphans
showStepHelper = ( function (_this)
{
return function (e)
{
if (_this._isOrphan(step))
{
// Is this an unintended orphan?
if (step.orphan === false && step.showIfUnintendedOrphan === false)
{
_this._debug("Skip the orphan step " + (_this._current + 1) + ".\nOrphan option is false and the element " + step.element + " does not exist or is hidden.");
if(typeof(step.onElementUnavailable) == "function")
{
_this._debug("Calling onElementUnavailable callback");
step.onElementUnavailable(_this, _this._current);
}
if (skipToPrevious) {
_this._showPrevStep(true);
} else {
_this._showNextStep(true);
}
return;
}
if (step.orphan === false && step.showIfUnintendedOrphan === true)
{
// it's an unintended orphan, and global or step options still want to show it
_this._debug("Show the unintended orphan step " + (_this._current + 1) + ". showIfUnintendedOrphan option is true.");
}
else
{
// It's an intended orphan
_this._debug("Show the orphan step " + (_this._current + 1) + ". Orphans option is true.");
}
}
//console.log(step);
if (step.autoscroll && !_this._isOrphan(step))
{
_this._scrollIntoView(i);
}
else
{
_this._showPopoverAndOverlay(i);
}
if (step.duration) {
return _this.resume();
}
};
})(this);
// delay in millisec specified in step options
showDelay = step.delay.show || step.delay;
if ({}
.toString.call(showDelay) === '[object Number]' && showDelay > 0) {
this._debug("Wait " + showDelay + " milliseconds to show the step " + (this._current + 1));
window.setTimeout((function (_this) {
return function () {
return _this._callOnPromiseDone(promise, showStepHelper);
};
})(this), showDelay);
}
else
{
if(step.delayOnElement)
{
// delay by element existence or max delay (default 2 sec)
var $delayElement = null;
var delayFunc = null;
var _this = this;
var revalidateDelayElement = function() {
if(typeof(step.delayOnElement.delayElement) == "function")
return step.delayOnElement.delayElement();
else if(step.delayOnElement.delayElement == "element")
return $(step.element);
else
return $(step.delayOnElement.delayElement);
};
var $delayElement = revalidateDelayElement();
var delayElementLog = $delayElement.length > 0 ? $delayElement[0].tagName : step.delayOnElement.delayElement;
var delayMax = (step.delayOnElement.maxDelay ? step.delayOnElement.maxDelay : 2000);
this._debug("Wait for element " + delayElementLog + " visible or max " + delayMax + " milliseconds to show the step " + (this._current + 1));
delayFunc = window.setInterval( function()
{
_this._debug("Wait for element " + delayElementLog + ": checking...");
if($delayElement.length === 0) {
$delayElement = revalidateDelayElement();
}
if($delayElement.is(':visible'))
{
_this._debug("Wait for element " + delayElementLog + ": found, showing step");
window.clearInterval(delayFunc);
delayFunc = null;
return _this._callOnPromiseDone(promise, showStepHelper);
}
}, 250);
// set max delay to greater than default interval check for element appearance
if(delayMax < 250)
delayMax = 251;
// Set timer to kill the setInterval call after max delay time expires
window.setTimeout( function ()
{
if(delayFunc)
{
_this._debug("Wait for element " + delayElementLog + ": max timeout reached without element found");
window.clearInterval(delayFunc);
// showStepHelper will handle broken/missing/invisible element
return _this._callOnPromiseDone(promise, showStepHelper);
}
}, delayMax);
}
else
{
// no delay by milliseconds or delay by time
this._callOnPromiseDone(promise, showStepHelper);
}
}
return promise;
};
Tour.prototype.getCurrentStepIndex = function () {
return this._current;
};
Tour.prototype.setCurrentStep = function (value) {
if (value != null)
{
this._current = value;
this._setState('current_step', value);
}
else
{
this._current = this._getState('current_step');
this._current = this._current === null ? 0 : parseInt(this._current, 10);
}
return this;
};
Tour.prototype._setState = function (key, value) {
var e,
keyName;
if (this._options.storage) {
keyName = this._options.name + "_" + key;
try {
this._options.storage.setItem(keyName, value);
} catch (error) {
e = error;
if (e.code === DOMException.QUOTA_EXCEEDED_ERR) {
this._debug('LocalStorage quota exceeded. State storage failed.');
}
}
return this._options.afterSetState(keyName, value);
} else {
if (this._state == null) {
this._state = {};
}