Chris@0: /*
Chris@0: * jQuery Foundation Joyride Plugin 2.1
Chris@0: * http://foundation.zurb.com
Chris@0: * Copyright 2013, ZURB
Chris@0: * Free to use under the MIT license.
Chris@0: * http://www.opensource.org/licenses/mit-license.php
Chris@0: */
Chris@0:
Chris@0: /*jslint unparam: true, browser: true, indent: 2 */
Chris@0:
Chris@0: ;(function ($, window, undefined) {
Chris@0: 'use strict';
Chris@0:
Chris@0: var defaults = {
Chris@0: 'version' : '2.1',
Chris@0: 'tipLocation' : 'bottom', // 'top' or 'bottom' in relation to parent
Chris@0: 'nubPosition' : 'auto', // override on a per tooltip bases
Chris@0: 'scroll' : true, // whether to scroll to tips
Chris@0: 'scrollSpeed' : 300, // Page scrolling speed in milliseconds
Chris@0: 'timer' : 0, // 0 = no timer , all other numbers = timer in milliseconds
Chris@0: 'autoStart' : false, // true or false - false tour starts when restart called
Chris@0: 'startTimerOnClick' : true, // true or false - true requires clicking the first button start the timer
Chris@0: 'startOffset' : 0, // the index of the tooltip you want to start on (index of the li)
Chris@0: 'nextButton' : true, // true or false to control whether a next button is used
Chris@0: 'tipAnimation' : 'fade', // 'pop' or 'fade' in each tip
Chris@0: 'pauseAfter' : [], // array of indexes where to pause the tour after
Chris@0: 'tipAnimationFadeSpeed': 300, // when tipAnimation = 'fade' this is speed in milliseconds for the transition
Chris@0: 'cookieMonster' : false, // true or false to control whether cookies are used
Chris@0: 'cookieName' : 'joyride', // Name the cookie you'll use
Chris@0: 'cookieDomain' : false, // Will this cookie be attached to a domain, ie. '.notableapp.com'
Chris@0: 'cookiePath' : false, // Set to '/' if you want the cookie for the whole website
Chris@0: 'localStorage' : false, // true or false to control whether localstorage is used
Chris@0: 'localStorageKey' : 'joyride', // Keyname in localstorage
Chris@0: 'tipContainer' : 'body', // Where will the tip be attached
Chris@0: 'modal' : false, // Whether to cover page with modal during the tour
Chris@0: 'expose' : false, // Whether to expose the elements at each step in the tour (requires modal:true)
Chris@0: 'postExposeCallback' : $.noop, // A method to call after an element has been exposed
Chris@0: 'preRideCallback' : $.noop, // A method to call before the tour starts (passed index, tip, and cloned exposed element)
Chris@0: 'postRideCallback' : $.noop, // A method to call once the tour closes (canceled or complete)
Chris@0: 'preStepCallback' : $.noop, // A method to call before each step
Chris@0: 'postStepCallback' : $.noop, // A method to call after each step
Chris@0: 'template' : { // HTML segments for tip layout
Chris@0: 'link' : 'X',
Chris@0: 'timer' : '
',
Chris@0: 'tip' : '
',
Chris@0: 'wrapper' : '',
Chris@0: 'button' : '',
Chris@0: 'modal' : '',
Chris@0: 'expose' : '',
Chris@0: 'exposeCover': ''
Chris@0: }
Chris@0: },
Chris@0:
Chris@0: Modernizr = Modernizr || false,
Chris@0:
Chris@0: settings = {},
Chris@0:
Chris@0: methods = {
Chris@0:
Chris@0: init : function (opts) {
Chris@0: return this.each(function () {
Chris@0:
Chris@0: if ($.isEmptyObject(settings)) {
Chris@0: settings = $.extend(true, defaults, opts);
Chris@0:
Chris@0: // non configurable settings
Chris@0: settings.document = window.document;
Chris@0: settings.$document = $(settings.document);
Chris@0: settings.$window = $(window);
Chris@0: settings.$content_el = $(this);
Chris@0: settings.$body = $(settings.tipContainer);
Chris@0: settings.body_offset = $(settings.tipContainer).position();
Chris@0: settings.$tip_content = $('> li', settings.$content_el);
Chris@0: settings.paused = false;
Chris@0: settings.attempts = 0;
Chris@0:
Chris@0: settings.tipLocationPatterns = {
Chris@0: top: ['bottom'],
Chris@0: bottom: [], // bottom should not need to be repositioned
Chris@0: left: ['right', 'top', 'bottom'],
Chris@0: right: ['left', 'top', 'bottom']
Chris@0: };
Chris@0:
Chris@0: // are we using jQuery 1.7+
Chris@0: methods.jquery_check();
Chris@0:
Chris@0: // can we create cookies?
Chris@0: if (!$.isFunction($.cookie)) {
Chris@0: settings.cookieMonster = false;
Chris@0: }
Chris@0:
Chris@0: // generate the tips and insert into dom.
Chris@0: if ( (!settings.cookieMonster || !$.cookie(settings.cookieName) ) &&
Chris@0: (!settings.localStorage || !methods.support_localstorage() || !localStorage.getItem(settings.localStorageKey) ) ) {
Chris@0:
Chris@0: settings.$tip_content.each(function (index) {
Chris@0: methods.create({$li : $(this), index : index});
Chris@0: });
Chris@0:
Chris@0: // show first tip
Chris@0: if(settings.autoStart)
Chris@0: {
Chris@0: if (!settings.startTimerOnClick && settings.timer > 0) {
Chris@0: methods.show('init');
Chris@0: methods.startTimer();
Chris@0: } else {
Chris@0: methods.show('init');
Chris@0: }
Chris@0: }
Chris@0:
Chris@0: }
Chris@0:
Chris@0: settings.$document.on('click.joyride', '.joyride-next-tip, .joyride-modal-bg', function (e) {
Chris@0: e.preventDefault();
Chris@0:
Chris@0: if (settings.$li.next().length < 1) {
Chris@0: methods.end();
Chris@0: } else if (settings.timer > 0) {
Chris@0: clearTimeout(settings.automate);
Chris@0: methods.hide();
Chris@0: methods.show();
Chris@0: methods.startTimer();
Chris@0: } else {
Chris@0: methods.hide();
Chris@0: methods.show();
Chris@0: }
Chris@0:
Chris@0: });
Chris@0:
Chris@0: settings.$document.on('click.joyride', '.joyride-close-tip', function (e) {
Chris@0: e.preventDefault();
Chris@0: methods.end(true /* isAborted */);
Chris@0: });
Chris@0:
Chris@0: settings.$window.on('resize.joyride', function (e) {
Chris@0: if(settings.$li){
Chris@0: if(settings.exposed && settings.exposed.length>0){
Chris@0: var $els = $(settings.exposed);
Chris@0: $els.each(function(){
Chris@0: var $this = $(this);
Chris@0: methods.un_expose($this);
Chris@0: methods.expose($this);
Chris@0: });
Chris@0: }
Chris@0: if (methods.is_phone()) {
Chris@0: methods.pos_phone();
Chris@0: } else {
Chris@0: methods.pos_default();
Chris@0: }
Chris@0: }
Chris@0: });
Chris@0: } else {
Chris@0: methods.restart();
Chris@0: }
Chris@0:
Chris@0: });
Chris@0: },
Chris@0:
Chris@0: // call this method when you want to resume the tour
Chris@0: resume : function () {
Chris@0: methods.set_li();
Chris@0: methods.show();
Chris@0: },
Chris@0:
Chris@0: nextTip: function(){
Chris@0: if (settings.$li.next().length < 1) {
Chris@0: methods.end();
Chris@0: } else if (settings.timer > 0) {
Chris@0: clearTimeout(settings.automate);
Chris@0: methods.hide();
Chris@0: methods.show();
Chris@0: methods.startTimer();
Chris@0: } else {
Chris@0: methods.hide();
Chris@0: methods.show();
Chris@0: }
Chris@0: },
Chris@0:
Chris@0: tip_template : function (opts) {
Chris@0: var $blank, content, $wrapper;
Chris@0:
Chris@0: opts.tip_class = opts.tip_class || '';
Chris@0:
Chris@0: $blank = $(settings.template.tip).addClass(opts.tip_class);
Chris@0: content = $.trim($(opts.li).html()) +
Chris@0: methods.button_text(opts.button_text) +
Chris@0: settings.template.link +
Chris@0: methods.timer_instance(opts.index);
Chris@0:
Chris@0: $wrapper = $(settings.template.wrapper);
Chris@0: if (opts.li.attr('data-aria-labelledby')) {
Chris@0: $wrapper.attr('aria-labelledby', opts.li.attr('data-aria-labelledby'))
Chris@0: }
Chris@0: if (opts.li.attr('data-aria-describedby')) {
Chris@0: $wrapper.attr('aria-describedby', opts.li.attr('data-aria-describedby'))
Chris@0: }
Chris@0: $blank.append($wrapper);
Chris@0: $blank.first().attr('data-index', opts.index);
Chris@0: $('.joyride-content-wrapper', $blank).append(content);
Chris@0:
Chris@0: return $blank[0];
Chris@0: },
Chris@0:
Chris@0: timer_instance : function (index) {
Chris@0: var txt;
Chris@0:
Chris@0: if ((index === 0 && settings.startTimerOnClick && settings.timer > 0) || settings.timer === 0) {
Chris@0: txt = '';
Chris@0: } else {
Chris@0: txt = methods.outerHTML($(settings.template.timer)[0]);
Chris@0: }
Chris@0: return txt;
Chris@0: },
Chris@0:
Chris@0: button_text : function (txt) {
Chris@0: if (settings.nextButton) {
Chris@0: txt = $.trim(txt) || 'Next';
Chris@0: txt = methods.outerHTML($(settings.template.button).append(txt)[0]);
Chris@0: } else {
Chris@0: txt = '';
Chris@0: }
Chris@0: return txt;
Chris@0: },
Chris@0:
Chris@0: create : function (opts) {
Chris@0: // backwards compatibility with data-text attribute
Chris@0: var buttonText = opts.$li.attr('data-button') || opts.$li.attr('data-text'),
Chris@0: tipClass = opts.$li.attr('class'),
Chris@0: $tip_content = $(methods.tip_template({
Chris@0: tip_class : tipClass,
Chris@0: index : opts.index,
Chris@0: button_text : buttonText,
Chris@0: li : opts.$li
Chris@0: }));
Chris@0:
Chris@0: $(settings.tipContainer).append($tip_content);
Chris@0: },
Chris@0:
Chris@0: show : function (init) {
Chris@0: var opts = {}, ii, opts_arr = [], opts_len = 0, p,
Chris@0: $timer = null;
Chris@0:
Chris@0: // are we paused?
Chris@0: if (settings.$li === undefined || ($.inArray(settings.$li.index(), settings.pauseAfter) === -1)) {
Chris@0:
Chris@0: // don't go to the next li if the tour was paused
Chris@0: if (settings.paused) {
Chris@0: settings.paused = false;
Chris@0: } else {
Chris@0: methods.set_li(init);
Chris@0: }
Chris@0:
Chris@0: settings.attempts = 0;
Chris@0:
Chris@0: if (settings.$li.length && settings.$target.length > 0) {
Chris@0: if(init){ //run when we first start
Chris@0: settings.preRideCallback(settings.$li.index(), settings.$next_tip );
Chris@0: if(settings.modal){
Chris@0: methods.show_modal();
Chris@0: }
Chris@0: }
Chris@0: settings.preStepCallback(settings.$li.index(), settings.$next_tip );
Chris@0:
Chris@0: // parse options
Chris@0: opts_arr = (settings.$li.data('options') || ':').split(';');
Chris@0: opts_len = opts_arr.length;
Chris@0: for (ii = opts_len - 1; ii >= 0; ii--) {
Chris@0: p = opts_arr[ii].split(':');
Chris@0:
Chris@0: if (p.length === 2) {
Chris@0: opts[$.trim(p[0])] = $.trim(p[1]);
Chris@0: }
Chris@0: }
Chris@0: settings.tipSettings = $.extend({}, settings, opts);
Chris@0: settings.tipSettings.tipLocationPattern = settings.tipLocationPatterns[settings.tipSettings.tipLocation];
Chris@0:
Chris@0: if(settings.modal && settings.expose){
Chris@0: methods.expose();
Chris@0: }
Chris@0:
Chris@0: // scroll if not modal
Chris@0: if (!settings.$target.is("body") && settings.scroll) {
Chris@0: methods.scroll_to();
Chris@0: }
Chris@0:
Chris@0: if (methods.is_phone()) {
Chris@0: methods.pos_phone(true);
Chris@0: } else {
Chris@0: methods.pos_default(true);
Chris@0: }
Chris@0:
Chris@0: $timer = $('.joyride-timer-indicator', settings.$next_tip);
Chris@0:
Chris@0: if (/pop/i.test(settings.tipAnimation)) {
Chris@0:
Chris@0: $timer.outerWidth(0);
Chris@0:
Chris@0: if (settings.timer > 0) {
Chris@0:
Chris@0: settings.$next_tip.show();
Chris@0: $timer.animate({
Chris@0: width: $('.joyride-timer-indicator-wrap', settings.$next_tip).outerWidth()
Chris@0: }, settings.timer);
Chris@0:
Chris@0: } else {
Chris@0:
Chris@0: settings.$next_tip.show();
Chris@0:
Chris@0: }
Chris@0:
Chris@0:
Chris@0: } else if (/fade/i.test(settings.tipAnimation)) {
Chris@0:
Chris@0: $timer.outerWidth(0);
Chris@0:
Chris@0: if (settings.timer > 0) {
Chris@0:
Chris@0: settings.$next_tip.fadeIn(settings.tipAnimationFadeSpeed);
Chris@0:
Chris@0: settings.$next_tip.show();
Chris@0: $timer.animate({
Chris@0: width: $('.joyride-timer-indicator-wrap', settings.$next_tip).outerWidth()
Chris@0: }, settings.timer);
Chris@0:
Chris@0: } else {
Chris@0:
Chris@0: settings.$next_tip.fadeIn(settings.tipAnimationFadeSpeed);
Chris@0:
Chris@0: }
Chris@0: }
Chris@0:
Chris@0: settings.$current_tip = settings.$next_tip;
Chris@0: // Focus next button for keyboard users.
Chris@0: $('.joyride-next-tip', settings.$current_tip).focus();
Chris@0: methods.tabbable(settings.$current_tip);
Chris@0: // skip non-existent targets
Chris@0: } else if (settings.$li && settings.$target.length < 1) {
Chris@0:
Chris@0: methods.show();
Chris@0:
Chris@0: } else {
Chris@0:
Chris@0: methods.end();
Chris@0:
Chris@0: }
Chris@0: } else {
Chris@0:
Chris@0: settings.paused = true;
Chris@0:
Chris@0: }
Chris@0:
Chris@0: },
Chris@0:
Chris@0: // detect phones with media queries if supported.
Chris@0: is_phone : function () {
Chris@0: if (Modernizr) {
Chris@0: return Modernizr.mq('only screen and (max-width: 767px)');
Chris@0: }
Chris@0:
Chris@0: return (settings.$window.width() < 767) ? true : false;
Chris@0: },
Chris@0:
Chris@0: support_localstorage : function () {
Chris@0: if (Modernizr) {
Chris@0: return Modernizr.localstorage;
Chris@0: } else {
Chris@0: return !!window.localStorage;
Chris@0: }
Chris@0: },
Chris@0:
Chris@0: hide : function () {
Chris@0: if(settings.modal && settings.expose){
Chris@0: methods.un_expose();
Chris@0: }
Chris@0: if(!settings.modal){
Chris@0: $('.joyride-modal-bg').hide();
Chris@0: }
Chris@0: settings.$current_tip.hide();
Chris@0: settings.postStepCallback(settings.$li.index(), settings.$current_tip);
Chris@0: },
Chris@0:
Chris@0: set_li : function (init) {
Chris@0: if (init) {
Chris@0: settings.$li = settings.$tip_content.eq(settings.startOffset);
Chris@0: methods.set_next_tip();
Chris@0: settings.$current_tip = settings.$next_tip;
Chris@0: } else {
Chris@0: settings.$li = settings.$li.next();
Chris@0: methods.set_next_tip();
Chris@0: }
Chris@0:
Chris@0: methods.set_target();
Chris@0: },
Chris@0:
Chris@0: set_next_tip : function () {
Chris@0: settings.$next_tip = $('.joyride-tip-guide[data-index=' + settings.$li.index() + ']');
Chris@0: },
Chris@0:
Chris@0: set_target : function () {
Chris@0: var cl = settings.$li.attr('data-class'),
Chris@0: id = settings.$li.attr('data-id'),
Chris@0: $sel = function () {
Chris@0: if (id) {
Chris@0: return $(settings.document.getElementById(id));
Chris@0: } else if (cl) {
Chris@0: return $('.' + cl).filter(":visible").first();
Chris@0: } else {
Chris@0: return $('body');
Chris@0: }
Chris@0: };
Chris@0:
Chris@0: settings.$target = $sel();
Chris@0: },
Chris@0:
Chris@0: scroll_to : function () {
Chris@0: var window_half, tipOffset;
Chris@0:
Chris@0: window_half = settings.$window.height() / 2;
Chris@0: tipOffset = Math.ceil(settings.$target.offset().top - window_half + settings.$next_tip.outerHeight());
Chris@0:
Chris@0: $("html, body").stop().animate({
Chris@0: scrollTop: tipOffset
Chris@0: }, settings.scrollSpeed);
Chris@0: },
Chris@0:
Chris@0: paused : function () {
Chris@0: if (($.inArray((settings.$li.index() + 1), settings.pauseAfter) === -1)) {
Chris@0: return true;
Chris@0: }
Chris@0:
Chris@0: return false;
Chris@0: },
Chris@0:
Chris@0: destroy : function () {
Chris@0: if(!$.isEmptyObject(settings)){
Chris@0: settings.$document.off('.joyride');
Chris@0: }
Chris@0:
Chris@0: $(window).off('.joyride');
Chris@0: $('.joyride-close-tip, .joyride-next-tip, .joyride-modal-bg').off('.joyride');
Chris@0: $('.joyride-tip-guide, .joyride-modal-bg').remove();
Chris@0: clearTimeout(settings.automate);
Chris@0: settings = {};
Chris@0: },
Chris@0:
Chris@0: restart : function () {
Chris@0: if(!settings.autoStart)
Chris@0: {
Chris@0: if (!settings.startTimerOnClick && settings.timer > 0) {
Chris@0: methods.show('init');
Chris@0: methods.startTimer();
Chris@0: } else {
Chris@0: methods.show('init');
Chris@0: }
Chris@0: settings.autoStart = true;
Chris@0: }
Chris@0: else
Chris@0: {
Chris@0: methods.hide();
Chris@0: settings.$li = undefined;
Chris@0: methods.show('init');
Chris@0: }
Chris@0: },
Chris@0:
Chris@0: pos_default : function (init) {
Chris@0: var half_fold = Math.ceil(settings.$window.height() / 2),
Chris@0: tip_position = settings.$next_tip.offset(),
Chris@0: $nub = $('.joyride-nub', settings.$next_tip),
Chris@0: nub_width = Math.ceil($nub.outerWidth() / 2),
Chris@0: nub_height = Math.ceil($nub.outerHeight() / 2),
Chris@0: toggle = init || false;
Chris@0:
Chris@0: // tip must not be "display: none" to calculate position
Chris@0: if (toggle) {
Chris@0: settings.$next_tip.css('visibility', 'hidden');
Chris@0: settings.$next_tip.show();
Chris@0: }
Chris@0:
Chris@0: if (!settings.$target.is("body")) {
Chris@0: var
Chris@0: topAdjustment = settings.tipSettings.tipAdjustmentY ? parseInt(settings.tipSettings.tipAdjustmentY) : 0,
Chris@0: leftAdjustment = settings.tipSettings.tipAdjustmentX ? parseInt(settings.tipSettings.tipAdjustmentX) : 0;
Chris@0:
Chris@0: if (methods.bottom()) {
Chris@0: settings.$next_tip.css({
Chris@0: top: (settings.$target.offset().top + nub_height + settings.$target.outerHeight() + topAdjustment),
Chris@0: left: settings.$target.offset().left + leftAdjustment});
Chris@0:
Chris@0: if (/right/i.test(settings.tipSettings.nubPosition)) {
Chris@0: settings.$next_tip.css('left', settings.$target.offset().left - settings.$next_tip.outerWidth() + settings.$target.outerWidth());
Chris@0: }
Chris@0:
Chris@0: methods.nub_position($nub, settings.tipSettings.nubPosition, 'top');
Chris@0:
Chris@0: } else if (methods.top()) {
Chris@0:
Chris@0: settings.$next_tip.css({
Chris@0: top: (settings.$target.offset().top - settings.$next_tip.outerHeight() - nub_height + topAdjustment),
Chris@0: left: settings.$target.offset().left + leftAdjustment});
Chris@0:
Chris@0: methods.nub_position($nub, settings.tipSettings.nubPosition, 'bottom');
Chris@0:
Chris@0: } else if (methods.right()) {
Chris@0:
Chris@0: settings.$next_tip.css({
Chris@0: top: settings.$target.offset().top + topAdjustment,
Chris@0: left: (settings.$target.outerWidth() + settings.$target.offset().left + nub_width) + leftAdjustment});
Chris@0:
Chris@0: methods.nub_position($nub, settings.tipSettings.nubPosition, 'left');
Chris@0:
Chris@0: } else if (methods.left()) {
Chris@0:
Chris@0: settings.$next_tip.css({
Chris@0: top: settings.$target.offset().top + topAdjustment,
Chris@0: left: (settings.$target.offset().left - settings.$next_tip.outerWidth() - nub_width) + leftAdjustment});
Chris@0:
Chris@0: methods.nub_position($nub, settings.tipSettings.nubPosition, 'right');
Chris@0:
Chris@0: }
Chris@0:
Chris@0: if (!methods.visible(methods.corners(settings.$next_tip)) && settings.attempts < settings.tipSettings.tipLocationPattern.length) {
Chris@0:
Chris@0: $nub.removeClass('bottom')
Chris@0: .removeClass('top')
Chris@0: .removeClass('right')
Chris@0: .removeClass('left');
Chris@0:
Chris@0: settings.tipSettings.tipLocation = settings.tipSettings.tipLocationPattern[settings.attempts];
Chris@0:
Chris@0: settings.attempts++;
Chris@0:
Chris@0: methods.pos_default(true);
Chris@0:
Chris@0: }
Chris@0:
Chris@0: } else if (settings.$li.length) {
Chris@0:
Chris@0: methods.pos_modal($nub);
Chris@0:
Chris@0: }
Chris@0:
Chris@0: if (toggle) {
Chris@0: settings.$next_tip.hide();
Chris@0: settings.$next_tip.css('visibility', 'visible');
Chris@0: }
Chris@0:
Chris@0: },
Chris@0:
Chris@0: pos_phone : function (init) {
Chris@0: var tip_height = settings.$next_tip.outerHeight(),
Chris@0: tip_offset = settings.$next_tip.offset(),
Chris@0: target_height = settings.$target.outerHeight(),
Chris@0: $nub = $('.joyride-nub', settings.$next_tip),
Chris@0: nub_height = Math.ceil($nub.outerHeight() / 2),
Chris@0: toggle = init || false;
Chris@0:
Chris@0: $nub.removeClass('bottom')
Chris@0: .removeClass('top')
Chris@0: .removeClass('right')
Chris@0: .removeClass('left');
Chris@0:
Chris@0: if (toggle) {
Chris@0: settings.$next_tip.css('visibility', 'hidden');
Chris@0: settings.$next_tip.show();
Chris@0: }
Chris@0:
Chris@0: if (!settings.$target.is("body")) {
Chris@0:
Chris@0: if (methods.top()) {
Chris@0:
Chris@0: settings.$next_tip.offset({top: settings.$target.offset().top - tip_height - nub_height});
Chris@0: $nub.addClass('bottom');
Chris@0:
Chris@0: } else {
Chris@0:
Chris@0: settings.$next_tip.offset({top: settings.$target.offset().top + target_height + nub_height});
Chris@0: $nub.addClass('top');
Chris@0:
Chris@0: }
Chris@0:
Chris@0: } else if (settings.$li.length) {
Chris@0:
Chris@0: methods.pos_modal($nub);
Chris@0:
Chris@0: }
Chris@0:
Chris@0: if (toggle) {
Chris@0: settings.$next_tip.hide();
Chris@0: settings.$next_tip.css('visibility', 'visible');
Chris@0: }
Chris@0: },
Chris@0:
Chris@0: pos_modal : function ($nub) {
Chris@0: methods.center();
Chris@0: $nub.hide();
Chris@0:
Chris@0: methods.show_modal();
Chris@0:
Chris@0: },
Chris@0:
Chris@0: show_modal : function() {
Chris@0: if ($('.joyride-modal-bg').length < 1) {
Chris@0: $('body').append(settings.template.modal).show();
Chris@0: }
Chris@0:
Chris@0: if (/pop/i.test(settings.tipAnimation)) {
Chris@0: $('.joyride-modal-bg').show();
Chris@0: } else {
Chris@0: $('.joyride-modal-bg').fadeIn(settings.tipAnimationFadeSpeed);
Chris@0: }
Chris@0: },
Chris@0:
Chris@0: expose: function(){
Chris@0: var expose,
Chris@0: exposeCover,
Chris@0: el,
Chris@0: origCSS,
Chris@0: randId = 'expose-'+Math.floor(Math.random()*10000);
Chris@0: if (arguments.length>0 && arguments[0] instanceof $){
Chris@0: el = arguments[0];
Chris@0: } else if(settings.$target && !settings.$target.is("body")){
Chris@0: el = settings.$target;
Chris@0: } else {
Chris@0: return false;
Chris@0: }
Chris@0: if(el.length < 1){
Chris@0: if(window.console){
Chris@0: console.error('element not valid', el);
Chris@0: }
Chris@0: return false;
Chris@0: }
Chris@0: expose = $(settings.template.expose);
Chris@0: settings.$body.append(expose);
Chris@0: expose.css({
Chris@0: top: el.offset().top,
Chris@0: left: el.offset().left,
Chris@0: width: el.outerWidth(true),
Chris@0: height: el.outerHeight(true)
Chris@0: });
Chris@0: exposeCover = $(settings.template.exposeCover);
Chris@0: origCSS = {
Chris@0: zIndex: el.css('z-index'),
Chris@0: position: el.css('position')
Chris@0: };
Chris@0: el.css('z-index',expose.css('z-index')*1+1);
Chris@0: if(origCSS.position == 'static'){
Chris@0: el.css('position','relative');
Chris@0: }
Chris@0: el.data('expose-css',origCSS);
Chris@0: exposeCover.css({
Chris@0: top: el.offset().top,
Chris@0: left: el.offset().left,
Chris@0: width: el.outerWidth(true),
Chris@0: height: el.outerHeight(true)
Chris@0: });
Chris@0: settings.$body.append(exposeCover);
Chris@0: expose.addClass(randId);
Chris@0: exposeCover.addClass(randId);
Chris@0: if(settings.tipSettings['exposeClass']){
Chris@0: expose.addClass(settings.tipSettings['exposeClass']);
Chris@0: exposeCover.addClass(settings.tipSettings['exposeClass']);
Chris@0: }
Chris@0: el.data('expose', randId);
Chris@0: settings.postExposeCallback(settings.$li.index(), settings.$next_tip, el);
Chris@0: methods.add_exposed(el);
Chris@0: },
Chris@0:
Chris@0: un_expose: function(){
Chris@0: var exposeId,
Chris@0: el,
Chris@0: expose ,
Chris@0: origCSS,
Chris@0: clearAll = false;
Chris@0: if (arguments.length>0 && arguments[0] instanceof $){
Chris@0: el = arguments[0];
Chris@0: } else if(settings.$target && !settings.$target.is("body")){
Chris@0: el = settings.$target;
Chris@0: } else {
Chris@0: return false;
Chris@0: }
Chris@0: if(el.length < 1){
Chris@0: if(window.console){
Chris@0: console.error('element not valid', el);
Chris@0: }
Chris@0: return false;
Chris@0: }
Chris@0: exposeId = el.data('expose');
Chris@0: expose = $('.'+exposeId);
Chris@0: if(arguments.length>1){
Chris@0: clearAll = arguments[1];
Chris@0: }
Chris@0: if(clearAll === true){
Chris@0: $('.joyride-expose-wrapper,.joyride-expose-cover').remove();
Chris@0: } else {
Chris@0: expose.remove();
Chris@0: }
Chris@0: origCSS = el.data('expose-css');
Chris@0: if(origCSS.zIndex == 'auto'){
Chris@0: el.css('z-index', '');
Chris@0: } else {
Chris@0: el.css('z-index',origCSS.zIndex);
Chris@0: }
Chris@0: if(origCSS.position != el.css('position')){
Chris@0: if(origCSS.position == 'static'){// this is default, no need to set it.
Chris@0: el.css('position', '');
Chris@0: } else {
Chris@0: el.css('position',origCSS.position);
Chris@0: }
Chris@0: }
Chris@0: el.removeData('expose');
Chris@0: el.removeData('expose-z-index');
Chris@0: methods.remove_exposed(el);
Chris@0: },
Chris@0:
Chris@0: add_exposed: function(el){
Chris@0: settings.exposed = settings.exposed || [];
Chris@0: if(el instanceof $){
Chris@0: settings.exposed.push(el[0]);
Chris@0: } else if(typeof el == 'string'){
Chris@0: settings.exposed.push(el);
Chris@0: }
Chris@0: },
Chris@0:
Chris@0: remove_exposed: function(el){
Chris@0: var search;
Chris@0: if(el instanceof $){
Chris@0: search = el[0]
Chris@0: } else if (typeof el == 'string'){
Chris@0: search = el;
Chris@0: }
Chris@0: settings.exposed = settings.exposed || [];
Chris@0: for(var i=0; i bottom){
Chris@0: bottom = offsetBottom;
Chris@0: }
Chris@0:
Chris@0: return [
Chris@0: el.offset().top < top,
Chris@0: right < el.offset().left + el.outerWidth(),
Chris@0: bottom < el.offset().top + el.outerHeight(),
Chris@0: w.scrollLeft() > el.offset().left
Chris@0: ];
Chris@0: },
Chris@0:
Chris@0: visible : function (hidden_corners) {
Chris@0: var i = hidden_corners.length;
Chris@0:
Chris@0: while (i--) {
Chris@0: if (hidden_corners[i]) return false;
Chris@0: }
Chris@0:
Chris@0: return true;
Chris@0: },
Chris@0:
Chris@0: nub_position : function (nub, pos, def) {
Chris@0: if (pos === 'auto') {
Chris@0: nub.addClass(def);
Chris@0: } else {
Chris@0: nub.addClass(pos);
Chris@0: }
Chris@0: },
Chris@0:
Chris@0: startTimer : function () {
Chris@0: if (settings.$li.length) {
Chris@0: settings.automate = setTimeout(function () {
Chris@0: methods.hide();
Chris@0: methods.show();
Chris@0: methods.startTimer();
Chris@0: }, settings.timer);
Chris@0: } else {
Chris@0: clearTimeout(settings.automate);
Chris@0: }
Chris@0: },
Chris@0:
Chris@0: end : function (isAborted) {
Chris@0: isAborted = isAborted || false;
Chris@0:
Chris@0: // Unbind resize events.
Chris@0: if (isAborted) {
Chris@0: settings.$window.off('resize.joyride');
Chris@0: }
Chris@0:
Chris@0: if (settings.cookieMonster) {
Chris@0: $.cookie(settings.cookieName, 'ridden', { expires: 365, domain: settings.cookieDomain, path: settings.cookiePath });
Chris@0: }
Chris@0:
Chris@0: if (settings.localStorage) {
Chris@0: localStorage.setItem(settings.localStorageKey, true);
Chris@0: }
Chris@0:
Chris@0: if (settings.timer > 0) {
Chris@0: clearTimeout(settings.automate);
Chris@0: }
Chris@0: if(settings.modal && settings.expose){
Chris@0: methods.un_expose();
Chris@0: }
Chris@0: if (settings.$current_tip) {
Chris@0: settings.$current_tip.hide();
Chris@0: }
Chris@0: if (settings.$li) {
Chris@0: settings.postStepCallback(settings.$li.index(), settings.$current_tip, isAborted);
Chris@0: settings.postRideCallback(settings.$li.index(), settings.$current_tip, isAborted);
Chris@0: }
Chris@0: $('.joyride-modal-bg').hide();
Chris@0: },
Chris@0:
Chris@0: jquery_check : function () {
Chris@0: // define on() and off() for older jQuery
Chris@0: if (!$.isFunction($.fn.on)) {
Chris@0:
Chris@0: $.fn.on = function (types, sel, fn) {
Chris@0:
Chris@0: return this.delegate(sel, types, fn);
Chris@0:
Chris@0: };
Chris@0:
Chris@0: $.fn.off = function (types, sel, fn) {
Chris@0:
Chris@0: return this.undelegate(sel, types, fn);
Chris@0:
Chris@0: };
Chris@0:
Chris@0: return false;
Chris@0: }
Chris@0:
Chris@0: return true;
Chris@0: },
Chris@0:
Chris@0: outerHTML : function (el) {
Chris@0: // support FireFox < 11
Chris@0: return el.outerHTML || new XMLSerializer().serializeToString(el);
Chris@0: },
Chris@0:
Chris@0: version : function () {
Chris@0: return settings.version;
Chris@0: },
Chris@0:
Chris@0: tabbable : function (el) {
Chris@0: $(el).on('keydown', function( event ) {
Chris@0: if (!event.isDefaultPrevented() && event.keyCode &&
Chris@0: // Escape key.
Chris@0: event.keyCode === 27 ) {
Chris@0: event.preventDefault();
Chris@0: methods.end(true /* isAborted */);
Chris@0: return;
Chris@0: }
Chris@0:
Chris@0: // Prevent tabbing out of tour items.
Chris@0: if ( event.keyCode !== 9 ) {
Chris@0: return;
Chris@0: }
Chris@0: var tabbables = $(el).find(":tabbable"),
Chris@0: first = tabbables.filter(":first"),
Chris@0: last = tabbables.filter(":last");
Chris@0: if ( event.target === last[0] && !event.shiftKey ) {
Chris@0: first.focus( 1 );
Chris@0: event.preventDefault();
Chris@0: } else if ( event.target === first[0] && event.shiftKey ) {
Chris@0: last.focus( 1 );
Chris@0: event.preventDefault();
Chris@0: }
Chris@0: });
Chris@0: }
Chris@0:
Chris@0: };
Chris@0:
Chris@0: $.fn.joyride = function (method) {
Chris@0: if (methods[method]) {
Chris@0: return methods[method].apply(this, Array.prototype.slice.call(arguments, 1));
Chris@0: } else if (typeof method === 'object' || !method) {
Chris@0: return methods.init.apply(this, arguments);
Chris@0: } else {
Chris@0: $.error('Method ' + method + ' does not exist on jQuery.joyride');
Chris@0: }
Chris@0: };
Chris@0:
Chris@0: }(jQuery, this));