updated intro Tour behavior

This commit is contained in:
Adriaan Wormgoor 2013-10-23 17:01:59 +02:00
parent 7daa661f3c
commit 3058ef5c79
4 changed files with 256 additions and 86 deletions

View File

@ -4,6 +4,7 @@ function GrandTour(_name) {
console.log("GrandTour");
this.tour = "";
this.name = _name;
this.active = false;
var self = this;
this.init = function() {
@ -20,17 +21,18 @@ function GrandTour(_name) {
'nubPosition': 'auto', // override on a per tooltip bases
'scrollSpeed': 300, // Page scrolling speed in ms
// 'timer': 2000, // 0 = off, all other numbers = time(ms)
'startTimerOnClick': true, // true/false to start timer on first click
// 'startTimerOnClick': true, // true/false to start timer on first click
'nextButton': true, // true/false for next button visibility
'tipAnimation': 'fade', // 'pop' or 'fade' in each tip
'pauseAfter': [], // array of indexes where to pause the tour after
'tipAnimationFadeSpeed': 250, // if 'fade'- speed in ms of transition
// 'pauseAfter': [], // array of indexes where to pause the tour after
'tipAnimationFadeSpeed': 350, // if 'fade'- speed in ms of transition
// 'cookieMonster': true, // true/false for whether cookies are used
// 'cookieDomain': false, // set to false or yoursite.com
// 'cookieName': 'Doodle3DFirstTime', // choose your own cookie name
// 'localStorage': true, //
// 'localStorageKey': 'Doodle3DFirstTime', // choose your own cookie name
'preRideCallback' : self.preRideCallback,
'preStepCallback': self.preStepCallback, // A method to call before each step
'postStepCallback': self.postStepCallback, // A method to call after each step
'postRideCallback': self.postRideCallback // a method to call once the tour closes
});
@ -40,41 +42,126 @@ function GrandTour(_name) {
this.preRideCallback = function(index, tip) {
console.log("GrandTour >> f:preRideCallback() >> index: " + index);
if ($.cookie("Doodle3DFirstTime") == "ridden" && index == 0) {
console.log("we've been here before...");
// $(this).joyride('set_li', false, 1);
if (index == 0 && $.cookie("Doodle3DFirstTime") == "ridden") {
console.log("GrandTour >> f:preRideCallback() >> we've been here before...");
if ($.cookie("grandTourFinished")) {
// grand tour was previously finished (eh.. is that useful?)
// executing this 3 times because there doesn't seem to be a 'go to step X' method
// $(this).joyride('set_li', false);
$(this).joyride('set_li', false);
$(this).joyride('set_li', false);
} else {
$(this).joyride('set_li', false);
}
}
if ($.cookie("Doodle3DFirstTime") == 'ridden') {
console.log("we've been here before...");
$(this).joyride('set_li', false);
}
// bring up all the elements
thermometer.show();
progressbar.show();
// if ($.cookie("Doodle3DFirstTime") == 'ridden') {
// console.log("we've been here before...");
// $(this).joyride('set_li', false, 4);
// }
// if (index == 0) {
// console.log("...yeah");
// $(this).joyride('set_li', false, 1);
// }
};
this.preStepCallback = function(index, tip) {
console.log("GrandTour >> f:preStepCallback() >> index: " + index);
var dataset = $(this)[0].$li[0].dataset;
if (dataset.action != undefined) {
console.log(" THERE'S AN ACTION!");
switch (dataset.action) {
case "sayHello":
console.log(" action: sayHello");
break;
case "showMessage":
console.log(" action: showMessage");
message.set("Just a notification...", Message.NOTICE);
message.show();
break;
case "showProgressBar":
console.log(" action: showProgressBar");
progressbar.show();
break;
case "showThermometer":
console.log(" action: showThermometer");
thermometer.show();
break;
}
}
};
this.postStepCallback = function(index, tip) {
console.log("GrandTour >> f:postStepCallback() >> index: " + index);
var dataset = $(this)[0].$li[0].dataset;
if (dataset.action != undefined) {
console.log(" THERE *WAS* AN ACTION!");
switch (dataset.action) {
case "sayHello":
console.log(" action: sayHello");
break;
case "showMessage":
console.log(" action: showMessage");
// message.hide();
break;
case "showProgressBar":
console.log(" action: showProgressBar");
// progressbar.hide();
break;
case "showThermometer":
console.log(" action: showThermometer");
// thermometer.hide();
break;
}
}
};
this.postRideCallback = function(index, tip) {
console.log("GrandTour >> f:postRideCallback() >> index: " + index);
// console.log("GrandTour >> f:postRideCallback() >> index: " + index + ", self.active: " + self.active);
// console.log("GrandTour >> f:postRideCallback() >> this: " , self);
self.active = false;
$(document).trigger(helpTours.TOURFINISHED, self.name);
// hide the elements which were summoned for the purposes of the tour
thermometer.hide();
progressbar.hide();
message.hide();
// after seeing the grand tour for the first time ever, set cookie 'Doodle3DFirstTime' to true
if (!$.cookie("Doodle3DFirstTime")) {
$.cookie("Doodle3DFirstTime", 'ridden', { expires: 365, domain: false, path: '/' });
}
if (index < $(this)[0].$tip_content.length - 1) {
console.log("doPostRideCallback >> ENDED BEFORE END");
helpTours.startTour(helpTours.INFOREMINDER);
console.log("GrandTour >> f:postRideCallback() >> tour terminated before its true end");
// tour wasn't finished
// tour was ended prematurely. For only the first few visits, nag the user about being able to revisit the tour..
if (parseInt($.cookie("Doodle3DVisitCounter")) < helpTours.numTimesToShowNagPopup) {
helpTours.startTour(helpTours.INFOREMINDER, helpTours);
}
// infoReminderTour.start();
} else {
console.log("doPostRideCallback >> this is the end my friend...");
// tour was finished
console.log("GrandTour >> f:postRideCallback() >> tour ended at its true end");
// we should be at the end...
$.cookie("Doodle3DFirstTime", 'ridden', { expires: 365, domain: false, path: '/' });
if (!$.cookie("grandTourFinished") && parseInt($.cookie("Doodle3DVisitCounter")) < helpTours.numTimesToShowNagPopup) {
helpTours.startTour(helpTours.INFOREMINDER, helpTours);
}
$.cookie("grandTourFinished", 'yes', { expires: 365, domain: false, path: '/' });
}
};
this.start = function() {
console.log("GrandTour >> f:start()");
console.log("GrandTour >> f:start() >> this: " , this);
this.active = true;
$(window).joyride('restart');
// self.tour();
};
@ -85,6 +172,7 @@ function InfoReminderTour(_name) {
console.log("InfoReminderTour");
this.tour = "";
this.name = _name;
this.active = false;
var self = this;
this.init = function(callback) {
@ -97,12 +185,12 @@ function InfoReminderTour(_name) {
expose: true,
'tipAdjustmentX': 15,
'tipAdjustmentY': 15,
'tipLocation': 'left', // 'top' or 'bottom' in relation to parent
'tipLocation': 'bottom', // 'top' or 'bottom' in relation to parent
'nubPosition': 'auto', // override on a per tooltip bases
'scrollSpeed': 300, // Page scrolling speed in ms
'nextButton': true, // true/false for next button visibility
'tipAnimation': 'fade', // 'pop' or 'fade' in each tip
'tipAnimationFadeSpeed': 250, // if 'fade'- speed in ms of transition
'tipAnimationFadeSpeed': 350, // if 'fade'- speed in ms of transition
'preRideCallback' : self.preRideCallback,
'postStepCallback': self.postStepCallback, // A method to call after each step
'postRideCallback': self.postRideCallback // a method to call once the tour closes
@ -120,11 +208,13 @@ function InfoReminderTour(_name) {
};
this.postRideCallback = function(index, tip) {
console.log("InfoReminderTour >> f:postRideCallback() >> index: " + index + ", tip: " , tip);
this.active = false;
$(document).trigger(helpTours.TOURFINISHED, self.name);
};
this.start = function() {
console.log("InfoReminderTour >> f:start()");
this.active = true;
$(window).joyride('restart');
// self.tour();
};
@ -133,26 +223,31 @@ function InfoReminderTour(_name) {
function initHelp() {
console.log("f:initHelp()");
// track number of visits of this user
if ($.cookie("Doodle3DVisitCounter") == null) {
$.cookie("Doodle3DVisitCounter", '0');
} else {
$.cookie("Doodle3DVisitCounter", parseInt($.cookie("Doodle3DVisitCounter")) + 1);
}
// grandTour = new GrandTour();
// infoReminderTour = new InfoReminderTour();
// first call inits the tour
// joyride2();
// load the html file which describes the tour contents
$("#helpContainer").load("helpcontent.html", function() {
console.log("helpContent loaded");
helpTours = new HelpTours();
helpTours.init();
// grandTour.init();
//// infoReminderTour.init();
//
// if ($.cookie("Doodle3DFirstTime") != "ridden") {
// console.log("intro tour has not been given yet > let's go!");
// setTimeout(grandTour.start, 1000);
// }
helpTours = new HelpTours();
helpTours.init( function () {
// only trigger starttour if user is seeing Doodle3D for the first time
if ($.cookie("Doodle3DFirstTime") != "ridden") {
console.log("initHelp >> intro tour has not been given yet > let's go!");
setTimeout(helpTours.startTour, 750, helpTours.tours.grandTour, helpTours);
} else if (parseInt($.cookie("Doodle3DVisitCounter")) < helpTours.numTimesToShowNagPopup) {
console.log("initHelp >> Doodle3DFirstTime cookie is set, Doodle3DVisitCounter is < 4");
// remind user of our nifty tour
setTimeout(helpTours.startTour, 750, helpTours.tours.infoReminderTour, helpTours);
}
});
});
}
@ -161,64 +256,97 @@ var helpTours;
function HelpTours() {
console.log("HelpTours");
this.numTimesToShowNagPopup = 4;
this.WELCOMETOUR = "welcometour";
this.INFOREMINDER = "inforeminder";
this.TOURFINISHED = "tourfinished";
this.tours = {
'grandTour' : this.WELCOMETOUR,
'infoReminderTour' : this.INFOREMINDER
};
this.currActiveTour = "";
this.tourActive = false;
var self = this;
this.init = function() {
console.log("HelpTours >> f:init");
this.init = function(callback) {
console.log("HelpTours >> f:init >> self: " + self);
$(document).on(this.TOURFINISHED, this.tourEnded);
grandTour = new GrandTour(this.WELCOMETOUR);
infoReminderTour = new InfoReminderTour(this.INFOREMINDER);
if ($.cookie("Doodle3DFirstTime") != "ridden") {
console.log("HelpTours >> f:init >> intro tour has not been given yet > let's go! (this.WELCOMETOUR = " + this.WELCOMETOUR + ")");
setTimeout(this.startTour, 1000, this.WELCOMETOUR);
}
// this.tours["grandTour"] = self.WELCOMETOUR;
// this.tours["infoReminderTour "]= self.INFOREMINDER;
console.log("HelpTours >> f:init >> this.tours: " , this.tours);
if (callback != undefined) callback();
};
this.startTour = function(which) {
console.log("HelpTours >> f:startTour >> target to start: '" + which);
this.startTour = function(which, scope) {
if (scope == undefined) scope = this;
// console.log("HelpTours >> f:startTour >> scope: " , scope);
// console.log("HelpTours >> f:startTour >> currActiveTour: " , scope.currActiveTour.name);
// console.log("HelpTours >> f:startTour >> currActiveTour.active: " , scope.currActiveTour.active);
// console.log("HelpTours >> f:startTour >> target to start: '" + which);
switch (which) {
case self.WELCOMETOUR:
case scope.WELCOMETOUR:
// do welcometour
console.log("HelpTours >> f:startTour >> case this.WELCOMETOUR >> self.tourActive = " + self.tourActive);
if (this.tourActive) {
$(window).joyride('end');
this.tourActive = false;
// console.log("HelpTours >> f:startTour >> case this.WELCOMETOUR >> scope.tourActive = " + scope.tourActive);
console.log("HelpTours >> f:startTour >> case this.WELCOMETOUR");
if (scope.tourActive) {
if (scope.currActiveTour.active == true) {
$(window).joyride('end');
scope.currActiveTour = undefined;
}
scope.tourActive = false;
}
$(window).joyride('destroy');
grandTour.init();
grandTour.start();
this.tourActive = true;
// var self = this;
grandTour.init();
setTimeout(function(scp) {
grandTour.start();
scp.currActiveTour = grandTour;
scp.tourActive = true;
}, 250, scope);
// $(window).joyride('restart');
break;
case self.INFOREMINDER:
// do info reminder
console.log("HelpTours >> f:startTour >> case self.INFOREMINDER >> self.tourActive = " + self.tourActive);
if (this.tourActive) {
$(window).joyride('end');
this.tourActive = false;
// console.log("HelpTours >> f:startTour >> case self.INFOREMINDER >> scope.tourActive = " + scope.tourActive);
console.log("HelpTours >> f:startTour >> case self.INFOREMINDER");
if (scope.tourActive) {
// console.log(" killing previous joyride... ");
if (scope.currActiveTour.active == true) {
$(window).joyride('end');
scope.currActiveTour = undefined;
}
// console.log(" setting tourActive to false....");
scope.tourActive = false;
// console.log(" scope.tourActive: " + scope.tourActive);
}
$(window).joyride('destroy');
infoReminderTour.init();
infoReminderTour.start();
this.tourActive = true;
// var self = this;
infoReminderTour.init();
setTimeout(function(scp) {
infoReminderTour.start();
scp.currActiveTour = infoReminderTour;
scp.tourActive = true;
}, 250, scope);
break;
}
}
this.tourEnded = function(e, n) {
console.log("HelpTours >> f:tourEnded >> name: " + n);
console.log("HelpTours >> f:tourEnded >> this.tourActive: " + self.tourActive + ", name: " + n);
this.tourActive = false;
self.tourActive = false;
}
}

View File

@ -23,7 +23,6 @@ var showOrHide = false;
$(function() {
console.log("ready");
//TODO give this a more logical place in code
if (getURLParameter("d") != "null") debugMode = (getURLParameter("d") == "1");

View File

@ -1,11 +1,8 @@
/* Artfully masterminded by ZURB */
body {
/*position: relative;*/
}
//#joyRideTipContent { display: none; }
//
//.joyRideTipContent { display: none; }
//@helpBlue: #2470E2;
@darkBlue: #013;
@helpBlue: #1B76FF;
@helpFullBlue: rgb(0,85,214);
@helpDarkBlue: darken(desaturate(@helpBlue, 25%), 35%);
/* Default styles for the container */
.joyride-tip-guide {
@ -13,7 +10,8 @@ body {
// background: #000;
background: rgba(255, 255, 255, 0.92);
display: none;
color: #222;
color: @darkBlue;
// color: rgb(0,99,255);
width: 300px;
z-index: 101;
top: 0; /* keeps the page from scrolling when calculating position */
@ -21,7 +19,9 @@ body {
// font-family: "HelveticaNeue", "Helvetica Neue", "Helvetica", Helvetica, Arial, Lucida, sans-serif;
font-weight: normal;
border-radius: 10px;
border: 3px solid #5FCE4F;
// border: 3px solid #5FCE4F;
// border: 3px solid #374952;
border: 3px solid @helpFullBlue;
box-shadow: 0 0 15px rgba(0, 0, 0, 0.4);
}
@ -64,7 +64,8 @@ body {
and override the top,left,right colors below.
*/
// border-color: #000;
border-color: rgba(67, 216, 20, 1.0);
// border-color: rgba(67, 216, 20, 1.0) !important;
border-color: @helpFullBlue !important;
// border-color: rgba(0,0,0,0.8);
border-top-color: transparent !important;
border-left-color: transparent !important;
@ -83,7 +84,8 @@ body {
and override the bottom,left,right colors below.
*/
// border-color: #000;
border-color: rgba(67, 216, 20, 1.0) !important;
// border-color: rgba(67, 216, 20, 1.0) !important;
border-color: @helpFullBlue !important;
// border-color: rgba(0,0,0,0.8) !important;
border-bottom-color: transparent !important;
border-left-color: transparent !important;
@ -95,7 +97,8 @@ body {
.joyride-tip-guide span.joyride-nub.right {
// border-color: #000;
border-color: rgba(67, 216, 20, 1.0) !important;
// border-color: rgba(67, 216, 20, 1.0) !important;
border-color: @helpFullBlue !important;
// border-color: rgba(0,0,0,0.8) !important;
border-top-color: transparent !important;
border-right-color: transparent !important;
@ -109,7 +112,8 @@ body {
.joyride-tip-guide span.joyride-nub.left {
// border-color: #000;
border-color: rgba(67, 216, 20, 1.0) !important;
// border-color: rgba(67, 216, 20, 1.0) !important;
border-color: @helpFullBlue !important;
// border-color: rgba(0,0,0,0.8) !important;
border-top-color: transparent !important;
border-left-color: transparent !important;
@ -122,8 +126,8 @@ body {
}
.joyride-tip-guide span.joyride-nub.top-right {
border-color: #000;
border-color: rgba(0,0,0,0.8);
// border-color: #000;
border-color: @helpFullBlue;
border-top-color: transparent !important;
border-left-color: transparent !important;
border-right-color: transparent !important;
@ -143,7 +147,8 @@ body {
line-height: 1.25;
margin: 0;
font-weight: bold;
color: #2DDF34;
// color: #2DDF34;
color: @helpFullBlue;
// color: #fff;
}
}
@ -160,12 +165,15 @@ body {
line-height: 18px;
}
.joyride-tip-guide a {
color: rgb(255,255,255);
// color: rgb(255,255,255);
color: @helpFullBlue;
text-decoration: none;
border-bottom: dotted 1px rgba(255,255,255,0.6);
// border-bottom: dotted 1px rgba(255,255,255,0.6);
border-bottom: dotted 1px lighten(@helpFullBlue, 20%);
}
.joyride-tip-guide a:hover {
color: rgba(255,255,255,0.8);
// color: rgba(255,255,255,0.8);
color: lighten(@helpFullBlue, 20%);
border-bottom: none;
}

View File

@ -16,30 +16,58 @@
<p>You can control all the details for you tour stop. Any valid HTML will work inside of Joyride.</p>
<p><a href="#">linkme beautiful</a>.</p>
</li>
<li data-class="btnsPrevNext" data-button="Next" data-options="tipLocation:right" data-action="sayHello">
<h2>previous and next</h2>
<p>Get the details right by styling Joyride with a custom stylesheet!</p>
</li>
<li data-class="btnSave" data-button="Next" data-options="tipLocation:right">
<h2>Save</h2>
<p>Get the details right by styling Joyride with a custom stylesheet!</p>
</li>
<li data-button="Next">
<h2>Modal</h2>
<p>It works as a modal too!</p>
</li>
<li data-class="btnOops" data-button="Next" data-options="tipLocation:right">
<h2>Oops</h2>
<p>It works right aligned.</p>
</li>
<li data-button="Next">
<h2>Now for the right panel</h2>
<p>It works as a modal too!</p>
</li>
<li data-class="rightpanel" data-button="Next" data-options="tipLocation:left">
<h2>Print</h2>
<h2>Right Panel</h2>
<p>It works with classes, and only on the first visible element with that class.</p>
</li>
<li data-class="btnPrint" data-button="Next" data-options="tipLocation:left">
<h2>Print</h2>
<p>It works with classes, and only on the first visible element with that class.</p>
</li>
<li data-class="btnStop" data-button="Close" data-options="tipLocation:left">
<li data-class="btnStop" data-button="Next" data-options="tipLocation:left">
<h2>Stop</h2>
<p>It works with classes, and only on the first visible element with that class.</p>
</li>
<li data-id="progressbarCanvasContainer" data-button="Next" data-options="tipLocation:left" data-action="showProgressBar">
<h2>progressguage</h2>
<p>It works with classes, and only on the first visible element with that class.</p>
</li>
<li data-id="thermometerContainer" data-button="Next" data-options="tipLocation:left" data-action="showThermometer">
<h2>Thermometer</h2>
<p>It works with classes, and only on the first visible element with that class.</p>
</li>
<li data-button="Show me" data-action="showMessage">
<h2>Status messages</h2>
<p>Status messages can inform you about the connection between Doodle3D and your 3D printer</p>
</li>
<li data-id="message" data-button="OK" data-options="tipLocation:bottom">
<h2>Status messages</h2>
<p>Status messages can inform you about the connection between Doodle3D and your 3D printer</p>
</li>
<li data-button="Finish">
<h2>That was the tour</h2>
<p>You're now ready to start using Doodle3d!</p>
</li>
<!--<li data-class="btnInfo" data-button="Got it" data-options="tipLocation:top">-->
<!--<h2>Reminder</h2>-->
<!--<p>You can always find this tour in the info window.</p>-->
<!--</li>-->
</ol>
<ol id="help_InfoReminder">
@ -49,6 +77,13 @@
</li>
</ol>
<ol id="help_grandTourFinishedInfoReminder">
<li data-class="btnInfo" data-button="Got it" data-options="tipLocation:top">
<h2>Reminder</h2>
<p>You can always find this tour in the info window.</p>
</li>
</ol>
<!-- Tip Content -->
<!--<ol id="joyrideTour">-->