/** * Intro.js v0.3.0 * https://github.com/usablica/intro.js * MIT licensed * * Copyright (C) 2013 usabli.ca - A weekend project by Afshin Mehrabani (@afshinmeh) */ (function (root, factory) { if (typeof exports === 'object') { // CommonJS factory(exports); } else if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. define(['exports'], factory); } else { // Browser globals factory(root); } } (this, function (exports) { //Default config/variables var VERSION = '0.3.0'; /** * IntroJs main class * * @class IntroJs */ function IntroJs(obj) { this._targetElement = obj; this._options = { nextLabel: 'Next →', prevLabel: '← Back', skipLabel: 'OK', tooltipPosition: 'bottom' }; } /** * Initiate a new introduction/guide from an element in the page * * @api private * @method _introForElement * @param {Object} targetElm * @returns {Boolean} Success or not? */ function _introForElement(targetElm) { var allIntroSteps = targetElm.querySelectorAll('*[data-intro]'), introItems = [], self = this; //if there's no element to intro if(allIntroSteps.length < 1) { return false; } for (var i = 0, elmsLength = allIntroSteps.length; i < elmsLength; i++) { var currentElement = allIntroSteps[i]; introItems.push({ element: currentElement, intro: currentElement.getAttribute('data-intro'), step: parseInt(currentElement.getAttribute('data-step'), 10), position: currentElement.getAttribute('data-position') || this._options.tooltipPosition }); } //Ok, sort all items with given steps introItems.sort(function (a, b) { return a.step - b.step; }); //set it to the introJs object self._introItems = introItems; //add overlay layer to the page if(_addOverlayLayer.call(self, targetElm)) { //then, start the show _nextStep.call(self); var skipButton = targetElm.querySelector('.introjs-skipbutton'), nextStepButton = targetElm.querySelector('.introjs-nextbutton'); self._onKeyDown = function(e) { if (e.keyCode === 27) { //escape key pressed, exit the intro _exitIntro.call(self, targetElm); } else if(e.keyCode === 37) { //left arrow _previousStep.call(self); } else if (e.keyCode === 39 || e.keyCode === 13) { //right arrow or enter _nextStep.call(self); } }; if (window.addEventListener) { window.addEventListener('keydown', self._onKeyDown, true); } else if (document.attachEvent) { //IE document.attachEvent('onkeydown', self._onKeyDown); } } return false; } /** * Go to specific step of introduction * * @api private * @method _goToStep */ function _goToStep(step) { //because steps starts with zero this._currentStep = step - 2; if(typeof (this._introItems) !== 'undefined') { _nextStep.call(this); } } /** * Go to next step on intro * * @api private * @method _nextStep */ function _nextStep() { if (typeof (this._currentStep) === 'undefined') { this._currentStep = 0; } else { ++this._currentStep; } if((this._introItems.length) <= this._currentStep) { //end of the intro //check if any callback is defined if (typeof (this._introCompleteCallback) === 'function') { this._introCompleteCallback.call(this); } _exitIntro.call(this, this._targetElement); return; } _showElement.call(this, this._introItems[this._currentStep].element); } /** * Go to previous step on intro * * @api private * @method _nextStep */ function _previousStep() { if (this._currentStep === 0) { return false; } _showElement.call(this, this._introItems[--this._currentStep].element); } /** * Exit from intro * * @api private * @method _exitIntro * @param {Object} targetElement */ function _exitIntro(targetElement) { //remove overlay layer from the page var overlayLayer = targetElement.querySelector('.introjs-overlay'); //for fade-out animation overlayLayer.style.opacity = 0; setTimeout(function () { if (overlayLayer.parentNode) { overlayLayer.parentNode.removeChild(overlayLayer); } }, 100); //remove all helper layers var helperLayer = targetElement.querySelector('.introjs-helperLayer'); if (helperLayer) { helperLayer.parentNode.removeChild(helperLayer); } //remove `introjs-showElement` class from the element var showElement = document.querySelector('.introjs-showElement'); if (showElement) { showElement.className = showElement.className.replace(/introjs-[a-zA-Z]+/g, '').replace(/^\s+|\s+$/g, ''); // This is a manual trim. } //clean listeners if (window.removeEventListener) { window.removeEventListener('keydown', this._onKeyDown, true); } else if (document.detachEvent) { //IE document.detachEvent('onkeydown', this._onKeyDown); } //set the step to zero this._currentStep = undefined; //check if any callback is defined if (this._introExitCallback != undefined) { this._introExitCallback.call(this); } } /** * Render tooltip box in the page * * @api private * @method _placeTooltip * @param {Object} targetElement * @param {Object} tooltipLayer * @param {Object} arrowLayer */ function _placeTooltip(targetElement, tooltipLayer, arrowLayer) { var tooltipLayerPosition = _getOffset(tooltipLayer); //reset the old style tooltipLayer.style.top = null; tooltipLayer.style.right = null; tooltipLayer.style.bottom = null; tooltipLayer.style.left = null; //prevent error when `this._currentStep` in undefined if(!this._introItems[this._currentStep]) return; var currentTooltipPosition = this._introItems[this._currentStep].position; switch (currentTooltipPosition) { case 'top': tooltipLayer.style.left = '15px'; tooltipLayer.style.top = '-' + (tooltipLayerPosition.height + 10) + 'px'; arrowLayer.className = 'introjs-arrow bottom'; break; case 'right': tooltipLayer.style.right = '-' + (tooltipLayerPosition.width + 10) + 'px'; arrowLayer.className = 'introjs-arrow left'; break; case 'left': tooltipLayer.style.top = '15px'; tooltipLayer.style.left = '-' + (tooltipLayerPosition.width + 10) + 'px'; arrowLayer.className = 'introjs-arrow right'; break; case 'bottom': // Bottom going to follow the default behavior default: tooltipLayer.style.bottom = '-' + (tooltipLayerPosition.height + 10) + 'px'; arrowLayer.className = 'introjs-arrow top'; break; } } /** * Show an element on the page * * @api private * @method _showElement * @param {Object} targetElement */ function _showElement(targetElement) { if (typeof (this._introChangeCallback) !== 'undefined') { this._introChangeCallback.call(this, targetElement); } var self = this, oldHelperLayer = document.querySelector('.introjs-helperLayer'), elementPosition = _getOffset(targetElement); if(oldHelperLayer != null) { var oldHelperNumberLayer = oldHelperLayer.querySelector('.introjs-helperNumberLayer'), oldtooltipLayer = oldHelperLayer.querySelector('.introjs-tooltiptext'), oldArrowLayer = oldHelperLayer.querySelector('.introjs-arrow'), oldtooltipContainer = oldHelperLayer.querySelector('.introjs-tooltip'); //hide the tooltip oldtooltipContainer.style.opacity = 0; //set new position to helper layer oldHelperLayer.setAttribute('style', 'width: ' + (elementPosition.width + 10) + 'px; ' + 'height:' + (elementPosition.height + 10) + 'px; ' + 'top:' + (elementPosition.top - 5) + 'px;' + 'left: ' + (elementPosition.left - 5) + 'px;'); //remove old classes var oldShowElement = document.querySelector('.introjs-showElement'); oldShowElement.className = oldShowElement.className.replace(/introjs-[a-zA-Z]+/g, '').replace(/^\s+|\s+$/g, ''); //we should wait until the CSS3 transition is competed (it's 0.3 sec) to prevent incorrect `height` and `width` calculation if (self._lastShowElementTimer) { clearTimeout(self._lastShowElementTimer); } self._lastShowElementTimer = setTimeout(function() { //set current step to the label oldHelperNumberLayer.innerHTML = targetElement.getAttribute('data-step'); //set current tooltip text oldtooltipLayer.innerHTML = targetElement.getAttribute('data-intro'); //set the tooltip position _placeTooltip.call(self, targetElement, oldtooltipContainer, oldArrowLayer); //show the tooltip oldtooltipContainer.style.opacity = 1; }, 100); } else { var helperLayer = document.createElement('div'), helperNumberLayer = document.createElement('span'), arrowLayer = document.createElement('div'), tooltipLayer = document.createElement('div'); helperLayer.className = 'introjs-helperLayer'; helperLayer.setAttribute('style', 'width: ' + (elementPosition.width + 10) + 'px; ' + 'height:' + (elementPosition.height + 10) + 'px; ' + 'top:' + (elementPosition.top - 5) + 'px;' + 'left: ' + (elementPosition.left - 5) + 'px;'); //add helper layer to target element this._targetElement.appendChild(helperLayer); helperNumberLayer.className = 'introjs-helperNumberLayer'; arrowLayer.className = 'introjs-arrow'; tooltipLayer.className = 'introjs-tooltip'; helperNumberLayer.innerHTML = targetElement.getAttribute('data-step'); tooltipLayer.innerHTML = '
' + '
' + "Can't Save - Validation Error" + '
' + targetElement.getAttribute('data-intro') + '
'; helperLayer.appendChild(helperNumberLayer); tooltipLayer.appendChild(arrowLayer); helperLayer.appendChild(tooltipLayer); //next button var nextTooltipButton = document.createElement('a'); nextTooltipButton.onclick = function() { _nextStep.call(self); }; nextTooltipButton.className = 'introjs-button introjs-nextbutton'; nextTooltipButton.href = 'javascript:void(0);'; nextTooltipButton.innerHTML = this._options.nextLabel; //previous button var prevTooltipButton = document.createElement('a'); prevTooltipButton.onclick = function() { _previousStep.call(self); }; prevTooltipButton.className = 'introjs-button introjs-prevbutton'; prevTooltipButton.href = 'javascript:void(0);'; prevTooltipButton.innerHTML = this._options.prevLabel; //skip button var skipTooltipButton = document.createElement('a'); skipTooltipButton.className = 'introjs-button introjs-skipbutton'; skipTooltipButton.href = 'javascript:void(0);'; skipTooltipButton.innerHTML = this._options.skipLabel; skipTooltipButton.onclick = function() { _exitIntro.call(self, self._targetElement); }; var tooltipButtonsLayer = tooltipLayer.querySelector('.introjs-tooltipbuttons'); tooltipButtonsLayer.appendChild(skipTooltipButton); tooltipButtonsLayer.appendChild(prevTooltipButton); tooltipButtonsLayer.appendChild(nextTooltipButton); //set proper position _placeTooltip.call(self, targetElement, tooltipLayer, arrowLayer); } //add target element position style targetElement.className += ' introjs-showElement'; //Thanks to JavaScript Kit: http://www.javascriptkit.com/dhtmltutors/dhtmlcascade4.shtml var currentElementPosition = ''; if (targetElement.currentStyle) { //IE currentElementPosition = targetElement.currentStyle['position']; } else if (document.defaultView && document.defaultView.getComputedStyle) { //Firefox currentElementPosition = document.defaultView.getComputedStyle(targetElement, null).getPropertyValue('position'); } //I don't know is this necessary or not, but I clear the position for better comparing currentElementPosition = currentElementPosition.toLowerCase(); if (currentElementPosition !== 'absolute' && currentElementPosition !== 'relative') { //change to new intro item targetElement.className += ' introjs-relativePosition'; } if (!_elementInViewport(targetElement)) { var rect = targetElement.getBoundingClientRect(), top = rect.bottom - (rect.bottom - rect.top), bottom = rect.bottom - _getWinSize().height; // Scroll up if (top < 0) { window.scrollBy(0, top - 30); // 30px padding from edge to look nice // Scroll down } else { window.scrollBy(0, bottom + 100); // 70px + 30px padding from edge to look nice } } } /** * Provides a cross-browser way to get the screen dimensions * via: http://stackoverflow.com/questions/5864467/internet-explorer-innerheight * * @api private * @method _getWinSize * @returns {Object} width and height attributes */ function _getWinSize() { if (window.innerWidth != undefined) { return { width: window.innerWidth, height: window.innerHeight }; } else { var D = document.documentElement; return { width: D.clientWidth, height: D.clientHeight }; } } /** * Add overlay layer to the page * http://stackoverflow.com/questions/123999/how-to-tell-if-a-dom-element-is-visible-in-the-current-viewport * * @api private * @method _elementInViewport * @param {Object} el */ function _elementInViewport(el) { var rect = el.getBoundingClientRect(); return ( rect.top >= 0 && rect.left >= 0 && (rect.bottom+80) <= window.innerHeight && // add 80 to get the text right rect.right <= window.innerWidth ); } /** * Add overlay layer to the page * * @api private * @method _addOverlayLayer * @param {Object} targetElm */ function _addOverlayLayer(targetElm) { var overlayLayer = document.createElement('div'), styleText = '', self = this; //set css class name overlayLayer.className = 'introjs-overlay'; //check if the target element is body, we should calculate the size of overlay layer in a better way if (targetElm.tagName.toLowerCase() === 'body') { styleText += 'top: 0;bottom: 0; left: 0;right: 0;position: fixed;'; overlayLayer.setAttribute('style', styleText); } else { //set overlay layer position var elementPosition = _getOffset(targetElm); if(elementPosition) { styleText += 'width: ' + elementPosition.width + 'px; height:' + elementPosition.height + 'px; top:' + elementPosition.top + 'px;left: ' + elementPosition.left + 'px;'; overlayLayer.setAttribute('style', styleText); } } targetElm.appendChild(overlayLayer); overlayLayer.onclick = function() { _exitIntro.call(self, targetElm); }; setTimeout(function() { styleText += 'opacity: .5;'; overlayLayer.setAttribute('style', styleText); }, 10); return true; } /** * Get an element position on the page * Thanks to `meouw`: http://stackoverflow.com/a/442474/375966 * * @api private * @method _getOffset * @param {Object} element * @returns Element's position info */ function _getOffset(element) { var elementPosition = {}; //set width elementPosition.width = element.offsetWidth; //set height elementPosition.height = element.offsetHeight; //calculate element top and left var _x = 0; var _y = 0; while(element && !isNaN(element.offsetLeft) && !isNaN(element.offsetTop)) { _x += element.offsetLeft; _y += element.offsetTop; element = element.offsetParent; } //set top elementPosition.top = _y; //set left elementPosition.left = _x; return elementPosition; } /** * Overwrites obj1's values with obj2's and adds obj2's if non existent in obj1 * via: http://stackoverflow.com/questions/171251/how-can-i-merge-properties-of-two-javascript-objects-dynamically * * @param obj1 * @param obj2 * @returns obj3 a new object based on obj1 and obj2 */ function _mergeOptions(obj1,obj2) { var obj3 = {}; for (var attrname in obj1) { obj3[attrname] = obj1[attrname]; } for (var attrname in obj2) { obj3[attrname] = obj2[attrname]; } return obj3; } var introJs = function (targetElm) { if (typeof (targetElm) === 'object') { //Ok, create a new instance return new IntroJs(targetElm); } else if (typeof (targetElm) === 'string') { //select the target element with query selector var targetElement = document.querySelector(targetElm); if (targetElement) { return new IntroJs(targetElement); } else { throw new Error('There is no element with given selector.'); } } else { return new IntroJs(document.body); } }; /** * Current IntroJs version * * @property version * @type String */ introJs.version = VERSION; //Prototype introJs.fn = IntroJs.prototype = { clone: function () { return new IntroJs(this); }, setOption: function(option, value) { this._options[option] = value; return this; }, setOptions: function(options) { this._options = _mergeOptions(this._options, options); return this; }, start: function () { _introForElement.call(this, this._targetElement); return this; }, goToStep: function(step) { _goToStep.call(this, step); return this; }, exit: function() { _exitIntro.call(this, this._targetElement); }, onchange: function(providedCallback) { if (typeof (providedCallback) === 'function') { this._introChangeCallback = providedCallback; } else { throw new Error('Provided callback for onchange was not a function.'); } return this; }, oncomplete: function(providedCallback) { if (typeof (providedCallback) === 'function') { this._introCompleteCallback = providedCallback; } else { throw new Error('Provided callback for oncomplete was not a function.'); } return this; }, onexit: function(providedCallback) { if (typeof (providedCallback) === 'function') { this._introExitCallback = providedCallback; } else { throw new Error('Provided callback for onexit was not a function.'); } return this; } }; exports.introJs = introJs; return introJs; }));