forked from IGreatlyDislikeJavascript/bootstrap-tourist
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbootstrap-tourist.js
executable file
·2426 lines (2084 loc) · 86.8 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.12
* 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 in the github repo. Ideally this fork
* will then be taken back into the main repo and become part of
* bootstrap-tour again - this is not a fork to create a new plugin!
*
* I'm not a JS coder, so suggest you test very carefully and read the
* docs (comments) below before using.
*
* If anyone would like to take on the creation of proper docs for
* Tourist, please feel free and post here:
* https://github.com/IGreatlyDislikeJavascript/bootstrap-tourist/issues/15
*
* ========================================================================
* ENTIRELY BASED UPON:
*
* bootstrap-tour - v0.12.0
* 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.
* ========================================================================
*
* Updated for CS by FFS 2018
*
* Changes IN v0.12 FROM v0.11:
* - note version labelling change in this changelog!
* - fixes to the button text change code and better prep for localization (thanks to @DancingDad, @thenewbeat, @bardware)
* - fixed css for BS4 progress text to correctly use float-right (thanks to @macroscian, @thenewbeat)
*
* Changes from v0.10:
* - added support for changing button texts (thanks to @vneri)
* - added dummy init() to support drop-in replacement for Tour (thanks to @pau1phi11ips)
*
* Changes from 0.9:
* - smartPlacement option removed, deprecated
* - default params compatibility for IE
* - auto progress bar was killed in changes 0.7 -> 0.8 due to Bootstrap sanitizer, this is readded
* - major change to manipulation of BS4 popper.js for orphan steps
* - change to implementation of backdrop
*
* Changes from 0.8:
* - The fast fix in v0.7 didn't work for Bootstrap 4. This release is to ensure fully working popovers in BS4. Issue is that the Bootstrap CDN
* doesn't actually have the whitelist property, so developing against it is basically useless :(
* - Improved BS4 support and template switching. Changed options for framework vs template.
*
* Changes from 0.7:
* - Fast release to fix breaking change in Bootstrap 3.4.1, fixes this issue: https://github.com/sorich87/bootstrap-tour/issues/723#issuecomment-471107788
* Issue is caused by the BS sanitizer, to avoid this reoccurring the "sanitizeWhitelist:" and "sanitizeFunction:" global options added
*
* Changes from 0.6:
* - Fixed invalid call to debug in _showNextStep()
* - Added onPreviouslyEnded() callback: https://github.com/sorich87/bootstrap-tour/issues/720
* - Added selector to switch between bootstrap3 and bootstrap4 or custom template, thanks to: https://github.com/sorich87/bootstrap-tour/pull/643
*
* Changes from 0.5:
* - Added "unfix" for bootstrap selectpicker to revert zindex after step that includes this plugin
* - Fixed issue with Bootstrap dialogs. Handling of dialogs is now robust
* - Fixed issue with BootstrapDialog plugin: https://nakupanda.github.io/bootstrap3-dialog/ . See notes below for help.
* - Improved the background overlay and scroll handling, unnecessary work removed
---------
This fork and code adds following features to Bootstrap Tour
1. onNext/onPrevious - prevent auto-move to next step, allow .goTo
2. *** Do not call Tour.init *** - fixed tours with hidden elements on page reload
3. Dynamically determine step element by function
4. Only continue tour when reflex element is clicked using reflexOnly
5. Call onElementUnavailable if step element is missing
6. Scroll flicker/continual step reload fixed
7. Magic progress bar and progress text, plus options to customize per step
8. Prevent user interaction with element using preventInteraction
9. Wait for arbitrary DOM element to be visible before showing tour step/crapping out due to missing element, using delayOnElement
10. Handle bootstrap modal dialogs better - autodetect modals or children of modals, and call onModalHidden to handle when user dismisses modal without following tour steps
11. Automagically fixes drawing issues with Bootstrap Selectpicker (https://github.com/snapappointments/bootstrap-select/)
12. Call onPreviouslyEnded if tour.start() is called for a tour that has previously ended (see docs)
13. Switch between Bootstrap 3 or 4 (popover methods and template) automatically using tour options
14. Added sanitizeWhitelist and sanitizeFunction global options
15. Added support for changing button texts
--------------
1. Control flow from onNext() / onPrevious() options:
Returning false from onNext/onPrevious handler will prevent Tour from automatically moving to the next/previous step.
Tour flow methods (Tour.goTo etc) now also work correctly in onNext/onPrevious.
Option is available per step or globally:
var tourSteps = [
{
element: "#inputBanana",
title: "Bananas!",
content: "Bananas are yellow, except when they're not",
onNext: function(tour){
if($('#inputBanana').val() !== "banana")
{
// no banana? highlight the banana field
$('#inputBanana').css("background-color", "red");
// do not jump to the next tour step!
return false;
}
}
}
];
var Tour=new Tour({
steps: tourSteps,
framework: "bootstrap3", // or "bootstrap4" depending on your version of bootstrap
buttonTexts:{ // customize or localize button texts
nextButton:"go on",
endTourButton:"ok it's over",
}
onNext: function(tour)
{
if(someVar = true)
{
// force the tour to jump to slide 3
tour.goTo(3);
// Prevent default move to next step - important!
return false;
}
}
});
--------------
2. Do not call Tour.init
When setting up Tour, do not call Tour.init().
Call Tour.start() to start/resume the Tour from previous step
Call Tour.restart() to always start Tour from first step
Tour.init() was a redundant method that caused conflict with hidden Tour elements.
As of Tourist v0.11, calling Tour.init() will generate a warning in the console (thanks to @pau1phi11ips).
---------------
3. Dynamically determine element by function
Step "element:" option allows element to be determined programmatically. Return a jquery object.
The following is possible:
var tourSteps = [
{
element: function() { return $(document).find("...something..."); },
title: "Dynamic",
content: "Element found by function"
},
{
element: "#static",
title: "Static",
content: "Element found by static ID"
}
];
---------------
4. Only continue tour when reflex element is clicked
Use step option reflexOnly in conjunction with step option reflex to automagically hide the "next" button in the tour, and only continue when the user clicks the element:
var tourSteps = [
{
element: "#myButton",
reflex: true,
reflexOnly: true,
title: "Click it",
content: "Click to continue, or you're stuck"
}
];
----------------
5. Call function when element is missing
If the element specified in the step (static or dynamically determined as per feature #3), onElementUnavailable is called.
Function signature: function(tour, stepNumber) {}
Option is available at global and per step levels.
Use it per step to have a step-specific error handler:
function tourStepBroken(tour, stepNumber)
{
alert("Uhoh, the tour broke on the #btnMagic element);
}
var tourSteps = [
{
element: "#btnMagic",
onElementUnavailable: tourStepBroken,
title: "Hold my beer",
content: "now watch this"
}
];
Use it globally, and optionally override per step, to have a robust and comprehensive error handler:
function tourBroken(tour, stepNumber)
{
alert("The default error handler: tour element is done broke on step number " + stepNumber);
}
var tourSteps = [
{
element: "#btnThis",
//onElementUnavailable: COMMENTED OUT, therefore default global handler used
title: "Some button",
content: "Some content"
},
{
element: "#btnThat",
onElementUnavailable: function(tour, stepNumber)
{
// override the default global handler for this step only
alert("The tour broke on #btnThat step");
},
title: "Another button",
content: "More content"
}
];
var Tour=new Tour({
steps: tourSteps,
framework: "bootstrap3", // or "bootstrap4" depending on your version of bootstrap
onElementUnavailable: tourBroken, // default "element unavailable" handler for all tour steps
});
---------------
6. Scroll flicker / continue reload fixed
Original Tour constantly reloaded the current tour step on scroll & similar events. This produced flickering, constant reloads and therefore constant calls to all the step function calls.
This is now fixed. Scrolling the browser window does not cause the tour step to reload.
IMPORTANT: orphan steps are stuck to the center of the screen. However steps linked to elements ALWAYS stay stuck to their element, even if user scrolls the element & tour popover
off the screen. This is my personal preference, as original functionality of tour step moving with the scroll even when the element was off the viewport seemed strange.
---------------
7. Progress bar & progress text:
With thanks to @macroscian, @thenewbeat for fixes to this code, incorporated in Tourist v0.12
Use the following options globally or per step to show tour progress:
showProgressBar - shows a bootstrap progress bar for tour progress at the top of the tour content
showProgressText - shows a textual progress (N/X, i.e.: 1/24 for slide 1 of 24) in the tour title
var tourSteps = [
{
element: "#inputBanana",
title: "Bananas!",
content: "Bananas are yellow, except when they're not",
},
{
element: "#inputOranges",
title: "Oranges!",
content: "Oranges are not bananas",
showProgressBar: false, // don't show the progress bar on this step only
showProgressText: false, // don't show the progress text on this step only
}
];
var Tour=new Tour({
framework: "bootstrap3", // or "bootstrap4" depending on your version of bootstrap
steps: tourSteps,
showProgressBar: true, // default show progress bar
showProgressText: true, // default show progress text
});
7b. Customize the progressbar/progress text:
In conjunction with 7a, provide the following functions globally or per step to draw your own progressbar/progress text:
getProgressBarHTML(percent)
getProgressTextHTML(stepNumber, percent, stepCount)
These will be called when each step is shown, with the appropriate percentage/step number etc passed to your function. Return an HTML string of a "drawn" progress bar/progress text
which will be directly inserted into the tour step.
Example:
var tourSteps = [
{
element: "#inputBanana",
title: "Bananas!",
content: "Bananas are yellow, except when they're not",
},
{
element: "#inputOranges",
title: "Oranges!",
content: "Oranges are not bananas",
getProgressBarHTML: function(percent)
{
// override the global progress bar function for this step
return '<div>You're ' + percent + ' of the way through!</div>';
}
}
];
var Tour=new Tour({
steps: tourSteps,
showProgressBar: true, // default show progress bar
showProgressText: true, // default show progress text
getProgressBarHTML: function(percent)
{
// default progress bar for all steps. Return valid HTML to draw the progress bar you want
return '<div class="progress"><div class="progress-bar progress-bar-striped" role="progressbar" style="width: ' + percent + '%;"></div></div>';
},
getProgressTextHTML: function(stepNumber, percent, stepCount)
{
// default progress text for all steps
return 'Slide ' + stepNumber + "/" + stepCount;
},
});
----------------
8. Prevent interaction with element
Sometimes you want to highlight a DOM element (button, input field) for a tour step, but don't want the user to be able to interact with it.
Use preventInteraction to stop the user touching the element:
var tourSteps = [
{
element: "#btnMCHammer",
preventInteraction: true,
title: "Hammer Time",
content: "You can't touch this"
}
];
----------------
9. Wait for an element to appear before continuing tour
Sometimes a tour step element might not be immediately ready because of transition effects etc. This is a specific issue with bootstrap select, which is relatively slow to show the selectpicker
dropdown after clicking.
Use delayOnElement to instruct Tour to wait for **ANY** element to appear before showing the step (or crapping out due to missing element). Yes this means the tour step element can be one DOM
element, but the delay will wait for a completely separate DOM element to appear. This is really useful for hidden divs etc.
Use in conjunction with onElementUnavailable for robust tour step handling.
delayOnElement is an object with the following:
delayOnElement: {
delayElement: "#waitForMe", // the element to wait to become visible, or the string literal "element" to use the step element
maxDelay: 2000, // optional milliseconds to wait/timeout for the element, before crapping out. If maxDelay is not specified, this is 2000ms by default
}
var tourSteps = [
{
element: "#btnPrettyTransition",
delayOnElement: {
delayElement: "element" // use string literal "element" to wait for this step's element, i.e.: #btnPrettyTransition
},
title: "Ages",
content: "This button takes ages to appear"
},
{
element: "#inputUnrelated",
delayOnElement: {
delayElement: "#divStuff" // wait until DOM element "divStuff" is visible before showing this tour step against DOM element "inputUnrelated"
},
title: "Waiting",
content: "This input is nice, but you only see this step when the other div appears"
},
{
element: "#btnDontForgetThis",
delayOnElement: {
delayElement: "element", // use string literal "element" to wait for this step's element, i.e.: #btnDontForgetThis
maxDelay: 5000 // wait 5 seconds for it to appear before timing out
},
title: "Cool",
content: "Remember the onElementUnavailable option!",
onElementUnavailable: function(tour, stepNumber)
{
// This will be called if btnDontForgetThis is not visible after 5 seconds
console.log("Well that went badly wrong");
}
},
];
----------------
10. Trigger when modal closes
If tour element is a modal, or is a DOM element inside a modal, the element can disappear "at random" if the user dismisses the dialog.
In this case, onModalHidden global and per step function is called. Only functional when step is not an orphan.
This is useful if a tour includes a step that launches a modal, and the tour requires the user to take some actions inside the modal before OK'ing it and moving to the next
tour step.
Return (int) step number to immediately move to that step
Return exactly false to not change tour state in any way - this is useful if you need to reshow the modal because some validation failed
Return anything else to move to the next step
element === Bootstrap modal, or element parent === bootstrap modal is automatically detected.
var Tour=new Tour({
steps: tourSteps,
framework: "bootstrap3", // or "bootstrap4" depending on your version of bootstrap
onModalHidden: function(tour, stepNumber)
{
console.log("Well damn, this step's element was a modal, or inside a modal, and the modal just done got dismissed y'all. Moving to step 3.");
// move to step number 3
return 3;
},
});
var Tour=new Tour({
steps: tourSteps,
onModalHidden: function(tour, stepNumber)
{
if(validateSomeModalContent() == false)
{
// The validation failed, user dismissed modal without properly taking actions.
// Show the modal again
showModalAgain();
// Instruct tour to stay on same step
return false;
}
else
{
// Content was valid. Return null or do nothing to instruct tour to continue to next step
}
},
});
10b. Handle Dialogs and BootstrapDialog plugin better https://nakupanda.github.io/bootstrap3-dialog/
Plugin makes creating dialogs very easy, but it does some extra stuff to the dialogs and dynamically creates/destroys them. This
causes issues with plugins that want to include a modal dialog in the steps using this plugin.
To use Tour to highlight an element in a dialog, just use the element ID as you would for any normal step. The dialog will be automatically
detected and handled.
To use Tour to highlight an entire dialog, set the step element to the dialog div. Tour will automatically realize this is a dialog, and
shift the element to use the modal-content div inside the dialog. This makes life friendly, because you can do this:
<div class="modal" id="myModal" role="dialog">
<div class="modal-dialog">
<div class="modal-content">
...blah...
</div>
</div>
</div>
Then use element: myModal in the Tour.
FOR BOOTSTRAPDIALOG PLUGIN: this plugin creates random UUIDs for the dialog DOM ID. You need to fix the ID to something you know. Do this:
dlg = new BootstrapDialog.confirm({
....all the options...
});
// BootstrapDialog gives a random GUID ID for dialog. Give it a proper one
$objModal = dlg.getModal();
$objModal.attr("id", "myModal");
dlg.setId("myModal");
Now you can use element: myModal in the tour, even when the dialog is created by BootstrapDialog plugin.
----------------
11. Fix conflict with Bootstrap Selectpicker: https://github.com/snapappointments/bootstrap-select/
Selectpicker draws a custom select. Tour now automagically finds and adjusts the selectpicker dropdown so that it appears correctly within the tour
----------------
12. Call onPreviouslyEnded if tour.start() is called for a tour that has previously ended
See the following github issue: https://github.com/sorich87/bootstrap-tour/issues/720
Original behavior for a tour that had previously ended was to call onStart() callback, and then abort without calling onEnd(). This has been altered so
that calling start() on a tour that has previously ended (cookie step set to end etc) will now ONLY call onPreviouslyEnded().
This restores the functionality that allows app JS to simply call tour.start() on page load, and the Tour will now only call onStart() / onEnd() when
the tour really is started or ended.
var Tour=new Tour({
steps: [ ..... ],
framework: "bootstrap3", // or "bootstrap4" depending on your version of bootstrap
onPreviouslyEnded: function(tour)
{
console.log("Looks like this tour has already ended");
},
});
tour.start();
----------------
13. Switch between Bootstrap 3 or 4 (popover methods, template) automatically using tour options, or use a custom template
With thanks to this thread: https://github.com/sorich87/bootstrap-tour/pull/643
Tour is compatible with bootstrap 3 and 4 if the right template and framework is used for the popover. Bootstrap3 framework compatibility is used by default.
To select the correct template and framework, use the "framework" global option. Note this option does more than just select a template, it also changes which
methods are used to manage the Tour popovers to be BS3 or BS4 compatible.
var Tour=new Tour({
steps: tourSteps,
template: null, // template option is null by default. Tourist will use the appropriate template
// for the framework version, in this case BS3 as per next option
framework: "bootstrap3", // can be string literal "bootstrap3" or "bootstrap4"
});
To use a custom template, use the "template" global option:
var Tour=new Tour({
steps: tourSteps,
framework: "bootstrap4", // can be string literal "bootstrap3" or "bootstrap4"
template: '<div class="popover" role="tooltip">....blah....</div>'
});
Review the following logic:
- If template == null, default framework template is used based on whether framework is set to "bootstrap3" or "bootstrap4"
- If template != null, the specified template is always used
- If framework option is not literal "bootstrap3" or "bootstrap4", error will occur
To add additional templates, search the code for "PLACEHOLDER: TEMPLATES LOCATION". This will take you to an array that contains the templates, simply edit
or add as required.
----------------
14. Options to manipulate the Bootstrap sanitizer, and fix the sanitizer related breaking change in BS 3.4.x
BS 3.4.1 added a sanitizer to popover and tooltips - this breaking change strips non-whitelisted DOM elements from popover content, title etc.
See: https://getbootstrap.com/docs/3.4/javascript/#js-sanitizer and https://blog.getbootstrap.com/2019/02/13/bootstrap-4-3-1-and-3-4-1/
This Bootstrap change resulted in Tour navigation buttons being killed from the DOM: https://github.com/sorich87/bootstrap-tour/issues/723#issuecomment-471107788
This has been fixed in code, Tour navigation buttons now appear and work by default.
To prevent future similar reoccurrences, and also allow the manipulation of the sanitizer "allowed list" for Tours that want to add extra content into
tour steps, two features added to global options. To understand the purpose and operation of these features, review the following information on the Bootstrap
sanitizer: https://getbootstrap.com/docs/3.4/javascript/#js-sanitizer
--IMPORTANT NOTE-- SECURITY RISK: if you do not understand the purpose of the sanitizer, why it exists in bootstrap or how it relates to Tour, do not use these options.
Global options:
sanitizeWhitelist: specify an object that will be merged with the Bootstrap Popover default whitelist. Use the same structure as the default Bootstrap
whitelist.
sanitizeFunction: specify a function that will be used to sanitize Tour content, with the following signature: string function(content).
Specifying a function for this option will cause sanitizeWhitelist to be ignored.
Specifying anything other than a function for this option will be ignored, and sanitizeWhitelist will be used
Examples:
Allow tour step content to include a button with attributes data-someplugin1="..." and data-somethingelse="...". Allow content to include a selectpicker.
var Tour=new Tour({
steps: tourSteps,
sanitizeWhitelist: {
"button" : ["data-someplugin1", "data-somethingelse"], // allows <button data-someplugin1="abc", data-somethingelse="xyz">
"select" : [] // allows <select>
}
});
Use a custom whitelist function for sanitizing tour steps:
var Tour=new Tour({
steps: tourSteps,
sanitizeFunction: function(stepContent)
{
// Bypass Bootstrap sanitizer using custom function to clean the tour step content.
// stepContent will contain the content of the step, i.e.: tourSteps[n].content. You must
// clean this content to prevent XSS and other vulnerabilities. Use your own code or a lib like DOMPurify
return DOMPurify.sanitize(stepContent);
}
});
Note: if you have complete control over the tour content (i.e.: no risk of XSS or similar attacks), you can use sanitizeFunction to bypass all sanitization
and use your step content exactly as is by simply returning the content:
var Tour=new Tour({
steps: tourSteps,
sanitizeFunction: function(stepContent)
{
// POTENTIAL SECURITY RISK
// bypass Bootstrap sanitizer, perform no sanitization, tour step content will be exactly as templated in tourSteps.
return stepContent;
}
});
----------------
15. Change text for the buttons in the popup (also, preparation for future localization options)
With thanks to @vneri (https://github.com/IGreatlyDislikeJavascript/bootstrap-tourist/pull/8) for the original change
With thanks to @DancingDad, @thenewbeat, @bardware for the fixes/updates
You can now change the text displayed for the buttons used in the tour step popups. For this, there is a new object you can pass to the options, called "localization".
This option only applies to the default templates. If you specify your own custom template, the localization.buttonTexts option has no effect on the basis that
you will make any changes to your own template directly.
var tour = new Tour({
framework: "bootstrap3", // or "bootstrap4" depending on your version of bootstrap
steps: [ ..... ],
localization:
{
buttonTexts: {
prevButton: 'Back',
nextButton: 'Go',
pauseButton: 'Wait',
resumeButton: 'Continue',
endTourButton: 'Ok, enough'
}
}
});
You may specify only the labels you want to change. Unspecified labels will remain at their defaults:
var tour = new Tour({
localization:
{
buttonTexts: {
endTourButton: 'Adios muchachos'
}
}
});
*
*/
(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 ($) {
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"
};
// take default options and overwrite with this tour options
this._options = $.extend(true,
{
name: 'tour',
steps: [],
container: 'body',
autoscroll: true,
keyboard: true,
storage: storage,
debug: false,
backdrop: false,
backdropContainer: 'body',
backdropPadding: 0,
redirect: true,
orphan: 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.framework !== "bootstrap3" && this._options.framework !== "bootstrap4")
{
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>',
};
// 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 == "bootstrap3" && $.fn.popover.Constructor.DEFAULTS.whiteList !== undefined)
{
defaultWhiteList = $.fn.popover.Constructor.DEFAULTS.whiteList;
}
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();
}
// Set 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',
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,
backdropContainer: this._options.backdropContainer,
backdropPadding: this._options.backdropPadding,
redirect: this._options.redirect,
reflexElement: this._options.steps[i].element,
preventInteraction: false,
orphan: this._options.orphan,
duration: this._options.duration,
delay: this._options.delay,
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]
);
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();
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.
// TODO: currently we destroy and recreate for both BS3 and BS4. Improvement could be to reposition backdrop overlay only when using BS4
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);
// };
// }