Apply JSHint and JSCS with jQuery configs

Closes gh-535. Closes gh-529.
This commit is contained in:
Fagner Brack
2016-04-16 16:47:51 +10:00
committed by Fagner Brack
parent 8e48883853
commit 3f4eddeb6e
5 changed files with 476 additions and 399 deletions

2
.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
/node_modules
/npm-debug.log

12
.jshintrc Normal file
View File

@@ -0,0 +1,12 @@
{
"boss": true,
"curly": true,
"eqeqeq": true,
"eqnull": true,
"expr": true,
"immed": true,
"noarg": true,
"quotmark": "double",
"undef": true,
"unused": true
}

View File

@@ -19,3 +19,4 @@ Guidelines:
* If proposing a feature, make sure to discuss that as an issue first. * If proposing a feature, make sure to discuss that as an issue first.
* Create a new [topic branch](https://github.com/dchelimsky/rspec/wiki/Topic-Branches) for every separate change you make. * Create a new [topic branch](https://github.com/dchelimsky/rspec/wiki/Topic-Branches) for every separate change you make.
* Make sure impress.js runs successfully on as many browsers as you can test. * Make sure impress.js runs successfully on as many browsers as you can test.
* Run `npm lint` to make sure the code is consistent with the project standards.

View File

@@ -21,30 +21,30 @@
// You are one of those who like to know how things work inside? // You are one of those who like to know how things work inside?
// Let me show you the cogs that make impress.js run... // Let me show you the cogs that make impress.js run...
(function ( document, window ) { ( function( document, window ) {
'use strict'; "use strict";
// HELPER FUNCTIONS // HELPER FUNCTIONS
// `pfx` is a function that takes a standard CSS property name as a parameter // `pfx` is a function that takes a standard CSS property name as a parameter
// and returns it's prefixed version valid for current browser it runs in. // and returns it's prefixed version valid for current browser it runs in.
// The code is heavily inspired by Modernizr http://www.modernizr.com/ // The code is heavily inspired by Modernizr http://www.modernizr.com/
var pfx = (function () { var pfx = ( function() {
var style = document.createElement('dummy').style, var style = document.createElement( "dummy" ).style,
prefixes = 'Webkit Moz O ms Khtml'.split(' '), prefixes = "Webkit Moz O ms Khtml".split( " " ),
memory = {}; memory = {};
return function ( prop ) { return function( prop ) {
if ( typeof memory[ prop ] === "undefined" ) { if ( typeof memory[ prop ] === "undefined" ) {
var ucProp = prop.charAt(0).toUpperCase() + prop.substr(1), var ucProp = prop.charAt( 0 ).toUpperCase() + prop.substr( 1 ),
props = (prop + ' ' + prefixes.join(ucProp + ' ') + ucProp).split(' '); props = ( prop + " " + prefixes.join( ucProp + " " ) + ucProp ).split( " " );
memory[ prop ] = null; memory[ prop ] = null;
for ( var i in props ) { for ( var i in props ) {
if ( style[ props[i] ] !== undefined ) { if ( style[ props[ i ] ] !== undefined ) {
memory[ prop ] = props[i]; memory[ prop ] = props[ i ];
break; break;
} }
} }
@@ -54,24 +54,24 @@
return memory[ prop ]; return memory[ prop ];
}; };
})(); } )();
// `arraify` takes an array-like object and turns it into real Array // `arraify` takes an array-like object and turns it into real Array
// to make all the Array.prototype goodness available. // to make all the Array.prototype goodness available.
var arrayify = function ( a ) { var arrayify = function( a ) {
return [].slice.call( a ); return [].slice.call( a );
}; };
// `css` function applies the styles given in `props` object to the element // `css` function applies the styles given in `props` object to the element
// given as `el`. It runs all property names through `pfx` function to make // given as `el`. It runs all property names through `pfx` function to make
// sure proper prefixed version of the property is used. // sure proper prefixed version of the property is used.
var css = function ( el, props ) { var css = function( el, props ) {
var key, pkey; var key, pkey;
for ( key in props ) { for ( key in props ) {
if ( props.hasOwnProperty(key) ) { if ( props.hasOwnProperty( key ) ) {
pkey = pfx(key); pkey = pfx( key );
if ( pkey !== null ) { if ( pkey !== null ) {
el.style[pkey] = props[key]; el.style[ pkey ] = props[ key ];
} }
} }
} }
@@ -81,83 +81,84 @@
// `toNumber` takes a value given as `numeric` parameter and tries to turn // `toNumber` takes a value given as `numeric` parameter and tries to turn
// it into a number. If it is not possible it returns 0 (or other value // it into a number. If it is not possible it returns 0 (or other value
// given as `fallback`). // given as `fallback`).
var toNumber = function (numeric, fallback) { var toNumber = function( numeric, fallback ) {
return isNaN(numeric) ? (fallback || 0) : Number(numeric); return isNaN( numeric ) ? ( fallback || 0 ) : Number( numeric );
}; };
// `byId` returns element with given `id` - you probably have guessed that ;) // `byId` returns element with given `id` - you probably have guessed that ;)
var byId = function ( id ) { var byId = function( id ) {
return document.getElementById(id); return document.getElementById( id );
}; };
// `$` returns first element for given CSS `selector` in the `context` of // `$` returns first element for given CSS `selector` in the `context` of
// the given element or whole document. // the given element or whole document.
var $ = function ( selector, context ) { var $ = function( selector, context ) {
context = context || document; context = context || document;
return context.querySelector(selector); return context.querySelector( selector );
}; };
// `$$` return an array of elements for given CSS `selector` in the `context` of // `$$` return an array of elements for given CSS `selector` in the `context` of
// the given element or whole document. // the given element or whole document.
var $$ = function ( selector, context ) { var $$ = function( selector, context ) {
context = context || document; context = context || document;
return arrayify( context.querySelectorAll(selector) ); return arrayify( context.querySelectorAll( selector ) );
}; };
// `triggerEvent` builds a custom DOM event with given `eventName` and `detail` data // `triggerEvent` builds a custom DOM event with given `eventName` and `detail` data
// and triggers it on element given as `el`. // and triggers it on element given as `el`.
var triggerEvent = function (el, eventName, detail) { var triggerEvent = function( el, eventName, detail ) {
var event = document.createEvent("CustomEvent"); var event = document.createEvent( "CustomEvent" );
event.initCustomEvent(eventName, true, true, detail); event.initCustomEvent( eventName, true, true, detail );
el.dispatchEvent(event); el.dispatchEvent( event );
}; };
// `translate` builds a translate transform string for given data. // `translate` builds a translate transform string for given data.
var translate = function ( t ) { var translate = function( t ) {
return " translate3d(" + t.x + "px," + t.y + "px," + t.z + "px) "; return " translate3d(" + t.x + "px," + t.y + "px," + t.z + "px) ";
}; };
// `rotate` builds a rotate transform string for given data. // `rotate` builds a rotate transform string for given data.
// By default the rotations are in X Y Z order that can be reverted by passing `true` // By default the rotations are in X Y Z order that can be reverted by passing `true`
// as second parameter. // as second parameter.
var rotate = function ( r, revert ) { var rotate = function( r, revert ) {
var rX = " rotateX(" + r.x + "deg) ", var rX = " rotateX(" + r.x + "deg) ",
rY = " rotateY(" + r.y + "deg) ", rY = " rotateY(" + r.y + "deg) ",
rZ = " rotateZ(" + r.z + "deg) "; rZ = " rotateZ(" + r.z + "deg) ";
return revert ? rZ+rY+rX : rX+rY+rZ; return revert ? rZ + rY + rX : rX + rY + rZ;
}; };
// `scale` builds a scale transform string for given data. // `scale` builds a scale transform string for given data.
var scale = function ( s ) { var scale = function( s ) {
return " scale(" + s + ") "; return " scale(" + s + ") ";
}; };
// `perspective` builds a perspective transform string for given data. // `perspective` builds a perspective transform string for given data.
var perspective = function ( p ) { var perspective = function( p ) {
return " perspective(" + p + "px) "; return " perspective(" + p + "px) ";
}; };
// `getElementFromHash` returns an element located by id from hash part of // `getElementFromHash` returns an element located by id from hash part of
// window location. // window location.
var getElementFromHash = function () { var getElementFromHash = function() {
// get id from url # by removing `#` or `#/` from the beginning,
// Get id from url # by removing `#` or `#/` from the beginning,
// so both "fallback" `#slide-id` and "enhanced" `#/slide-id` will work // so both "fallback" `#slide-id` and "enhanced" `#/slide-id` will work
return byId( window.location.hash.replace(/^#\/?/,"") ); return byId( window.location.hash.replace( /^#\/?/, "" ) );
}; };
// `computeWindowScale` counts the scale factor between window size and size // `computeWindowScale` counts the scale factor between window size and size
// defined for the presentation in the config. // defined for the presentation in the config.
var computeWindowScale = function ( config ) { var computeWindowScale = function( config ) {
var hScale = window.innerHeight / config.height, var hScale = window.innerHeight / config.height,
wScale = window.innerWidth / config.width, wScale = window.innerWidth / config.width,
scale = hScale > wScale ? wScale : hScale; scale = hScale > wScale ? wScale : hScale;
if (config.maxScale && scale > config.maxScale) { if ( config.maxScale && scale > config.maxScale ) {
scale = config.maxScale; scale = config.maxScale;
} }
if (config.minScale && scale < config.minScale) { if ( config.minScale && scale < config.minScale ) {
scale = config.minScale; scale = config.minScale;
} }
@@ -169,24 +170,26 @@
var ua = navigator.userAgent.toLowerCase(); var ua = navigator.userAgent.toLowerCase();
var impressSupported = var impressSupported =
// browser should support CSS 3D transtorms
( pfx("perspective") !== null ) &&
// and `classList` and `dataset` APIs // Browser should support CSS 3D transtorms
( pfx( "perspective" ) !== null ) &&
// Browser should support `classList` and `dataset` APIs
( body.classList ) && ( body.classList ) &&
( body.dataset ) && ( body.dataset ) &&
// but some mobile devices need to be blacklisted, // But some mobile devices need to be blacklisted,
// because their CSS 3D support or hardware is not // because their CSS 3D support or hardware is not
// good enough to run impress.js properly, sorry... // good enough to run impress.js properly, sorry...
( ua.search(/(iphone)|(ipod)|(android)/) === -1 ); ( ua.search( /(iphone)|(ipod)|(android)/ ) === -1 );
if (!impressSupported) { if ( !impressSupported ) {
// we can't be sure that `classList` is supported
// We can't be sure that `classList` is supported
body.className += " impress-not-supported "; body.className += " impress-not-supported ";
} else { } else {
body.classList.remove("impress-not-supported"); body.classList.remove( "impress-not-supported" );
body.classList.add("impress-supported"); body.classList.add( "impress-supported" );
} }
// GLOBALS AND DEFAULTS // GLOBALS AND DEFAULTS
@@ -196,7 +199,7 @@
// sure if it makes any sense in practice ;) // sure if it makes any sense in practice ;)
var roots = {}; var roots = {};
// some default config values. // Some default config values.
var defaults = { var defaults = {
width: 1024, width: 1024,
height: 768, height: 768,
@@ -208,8 +211,8 @@
transitionDuration: 1000 transitionDuration: 1000
}; };
// it's just an empty function ... and a useless comment. // It's just an empty function ... and a useless comment.
var empty = function () { return false; }; var empty = function() { return false; };
// IMPRESS.JS API // IMPRESS.JS API
@@ -217,12 +220,12 @@
// It's the core `impress` function that returns the impress.js API // It's the core `impress` function that returns the impress.js API
// for a presentation based on the element with given id ('impress' // for a presentation based on the element with given id ('impress'
// by default). // by default).
var impress = window.impress = function ( rootId ) { var impress = window.impress = function( rootId ) {
// If impress.js is not supported by the browser return a dummy API // If impress.js is not supported by the browser return a dummy API
// it may not be a perfect solution but we return early and avoid // it may not be a perfect solution but we return early and avoid
// running code that may use features not implemented in the browser. // running code that may use features not implemented in the browser.
if (!impressSupported) { if ( !impressSupported ) {
return { return {
init: empty, init: empty,
goto: empty, goto: empty,
@@ -233,32 +236,32 @@
rootId = rootId || "impress"; rootId = rootId || "impress";
// if given root is already initialized just return the API // If given root is already initialized just return the API
if (roots["impress-root-" + rootId]) { if ( roots[ "impress-root-" + rootId ] ) {
return roots["impress-root-" + rootId]; return roots[ "impress-root-" + rootId ];
} }
// data of all presentation steps // Data of all presentation steps
var stepsData = {}; var stepsData = {};
// element of currently active step // Element of currently active step
var activeStep = null; var activeStep = null;
// current state (position, rotation and scale) of the presentation // Current state (position, rotation and scale) of the presentation
var currentState = null; var currentState = null;
// array of step elements // Array of step elements
var steps = null; var steps = null;
// configuration options // Configuration options
var config = null; var config = null;
// scale factor of the browser window // Scale factor of the browser window
var windowScale = null; var windowScale = null;
// root presentation elements // Root presentation elements
var root = byId( rootId ); var root = byId( rootId );
var canvas = document.createElement("div"); var canvas = document.createElement( "div" );
var initialized = false; var initialized = false;
@@ -270,15 +273,15 @@
// `impress:stepleave` is triggered when the step is left (the // `impress:stepleave` is triggered when the step is left (the
// transition to next step just starts). // transition to next step just starts).
// reference to last entered step // Reference to last entered step
var lastEntered = null; var lastEntered = null;
// `onStepEnter` is called whenever the step element is entered // `onStepEnter` is called whenever the step element is entered
// but the event is triggered only if the step is different than // but the event is triggered only if the step is different than
// last entered step. // last entered step.
var onStepEnter = function (step) { var onStepEnter = function( step ) {
if (lastEntered !== step) { if ( lastEntered !== step ) {
triggerEvent(step, "impress:stepenter"); triggerEvent( step, "impress:stepenter" );
lastEntered = step; lastEntered = step;
} }
}; };
@@ -286,62 +289,62 @@
// `onStepLeave` is called whenever the step element is left // `onStepLeave` is called whenever the step element is left
// but the event is triggered only if the step is the same as // but the event is triggered only if the step is the same as
// last entered step. // last entered step.
var onStepLeave = function (step) { var onStepLeave = function( step ) {
if (lastEntered === step) { if ( lastEntered === step ) {
triggerEvent(step, "impress:stepleave"); triggerEvent( step, "impress:stepleave" );
lastEntered = null; lastEntered = null;
} }
}; };
// `initStep` initializes given step element by reading data from its // `initStep` initializes given step element by reading data from its
// data attributes and setting correct styles. // data attributes and setting correct styles.
var initStep = function ( el, idx ) { var initStep = function( el, idx ) {
var data = el.dataset, var data = el.dataset,
step = { step = {
translate: { translate: {
x: toNumber(data.x), x: toNumber( data.x ),
y: toNumber(data.y), y: toNumber( data.y ),
z: toNumber(data.z) z: toNumber( data.z )
}, },
rotate: { rotate: {
x: toNumber(data.rotateX), x: toNumber( data.rotateX ),
y: toNumber(data.rotateY), y: toNumber( data.rotateY ),
z: toNumber(data.rotateZ || data.rotate) z: toNumber( data.rotateZ || data.rotate )
}, },
scale: toNumber(data.scale, 1), scale: toNumber( data.scale, 1 ),
el: el el: el
}; };
if ( !el.id ) { if ( !el.id ) {
el.id = "step-" + (idx + 1); el.id = "step-" + ( idx + 1 );
} }
stepsData["impress-" + el.id] = step; stepsData[ "impress-" + el.id ] = step;
css(el, { css( el, {
position: "absolute", position: "absolute",
transform: "translate(-50%,-50%)" + transform: "translate(-50%,-50%)" +
translate(step.translate) + translate( step.translate ) +
rotate(step.rotate) + rotate( step.rotate ) +
scale(step.scale), scale( step.scale ),
transformStyle: "preserve-3d" transformStyle: "preserve-3d"
}); } );
}; };
// `init` API function that initializes (and runs) the presentation. // `init` API function that initializes (and runs) the presentation.
var init = function () { var init = function() {
if (initialized) { return; } if ( initialized ) { return; }
// First we set up the viewport for mobile devices. // First we set up the viewport for mobile devices.
// For some reason iPad goes nuts when it is not done properly. // For some reason iPad goes nuts when it is not done properly.
var meta = $("meta[name='viewport']") || document.createElement("meta"); var meta = $( "meta[name='viewport']" ) || document.createElement( "meta" );
meta.content = "width=device-width, minimum-scale=1, maximum-scale=1, user-scalable=no"; meta.content = "width=device-width, minimum-scale=1, maximum-scale=1, user-scalable=no";
if (meta.parentNode !== document.head) { if ( meta.parentNode !== document.head ) {
meta.name = 'viewport'; meta.name = "viewport";
document.head.appendChild(meta); document.head.appendChild( meta );
} }
// initialize configuration object // Initialize configuration object
var rootData = root.dataset; var rootData = root.dataset;
config = { config = {
width: toNumber( rootData.width, defaults.width ), width: toNumber( rootData.width, defaults.width ),
@@ -349,24 +352,26 @@
maxScale: toNumber( rootData.maxScale, defaults.maxScale ), maxScale: toNumber( rootData.maxScale, defaults.maxScale ),
minScale: toNumber( rootData.minScale, defaults.minScale ), minScale: toNumber( rootData.minScale, defaults.minScale ),
perspective: toNumber( rootData.perspective, defaults.perspective ), perspective: toNumber( rootData.perspective, defaults.perspective ),
transitionDuration: toNumber( rootData.transitionDuration, defaults.transitionDuration ) transitionDuration: toNumber(
rootData.transitionDuration, defaults.transitionDuration
)
}; };
windowScale = computeWindowScale( config ); windowScale = computeWindowScale( config );
// wrap steps with "canvas" element // Wrap steps with "canvas" element
arrayify( root.childNodes ).forEach(function ( el ) { arrayify( root.childNodes ).forEach( function( el ) {
canvas.appendChild( el ); canvas.appendChild( el );
}); } );
root.appendChild(canvas); root.appendChild( canvas );
// set initial styles // Set initial styles
document.documentElement.style.height = "100%"; document.documentElement.style.height = "100%";
css(body, { css( body, {
height: "100%", height: "100%",
overflow: "hidden" overflow: "hidden"
}); } );
var rootStyles = { var rootStyles = {
position: "absolute", position: "absolute",
@@ -375,22 +380,22 @@
transformStyle: "preserve-3d" transformStyle: "preserve-3d"
}; };
css(root, rootStyles); css( root, rootStyles );
css(root, { css( root, {
top: "50%", top: "50%",
left: "50%", left: "50%",
transform: perspective( config.perspective/windowScale ) + scale( windowScale ) transform: perspective( config.perspective / windowScale ) + scale( windowScale )
}); } );
css(canvas, rootStyles); css( canvas, rootStyles );
body.classList.remove("impress-disabled"); body.classList.remove( "impress-disabled" );
body.classList.add("impress-enabled"); body.classList.add( "impress-enabled" );
// get and init steps // Get and init steps
steps = $$(".step", root); steps = $$( ".step", root );
steps.forEach( initStep ); steps.forEach( initStep );
// set a default initial state of the canvas // Set a default initial state of the canvas
currentState = { currentState = {
translate: { x: 0, y: 0, z: 0 }, translate: { x: 0, y: 0, z: 0 },
rotate: { x: 0, y: 0, z: 0 }, rotate: { x: 0, y: 0, z: 0 },
@@ -399,31 +404,33 @@
initialized = true; initialized = true;
triggerEvent(root, "impress:init", { api: roots[ "impress-root-" + rootId ] }); triggerEvent( root, "impress:init", { api: roots[ "impress-root-" + rootId ] } );
}; };
// `getStep` is a helper function that returns a step element defined by parameter. // `getStep` is a helper function that returns a step element defined by parameter.
// If a number is given, step with index given by the number is returned, if a string // If a number is given, step with index given by the number is returned, if a string
// is given step element with such id is returned, if DOM element is given it is returned // is given step element with such id is returned, if DOM element is given it is returned
// if it is a correct step element. // if it is a correct step element.
var getStep = function ( step ) { var getStep = function( step ) {
if (typeof step === "number") { if ( typeof step === "number" ) {
step = step < 0 ? steps[ steps.length + step] : steps[ step ]; step = step < 0 ? steps[ steps.length + step ] : steps[ step ];
} else if (typeof step === "string") { } else if ( typeof step === "string" ) {
step = byId(step); step = byId( step );
} }
return (step && step.id && stepsData["impress-" + step.id]) ? step : null; return ( step && step.id && stepsData[ "impress-" + step.id ] ) ? step : null;
}; };
// used to reset timeout for `impress:stepenter` event // Used to reset timeout for `impress:stepenter` event
var stepEnterTimeout = null; var stepEnterTimeout = null;
// `goto` API function that moves to step given with `el` parameter (by index, id or element), // `goto` API function that moves to step given with `el` parameter
// with a transition `duration` optionally given as second parameter. // (by index, id or element), with a transition `duration` optionally
var goto = function ( el, duration ) { // given as second parameter.
var goto = function( el, duration ) {
if ( !initialized || !(el = getStep(el)) ) { if ( !initialized || !( el = getStep( el ) ) ) {
// presentation not initialized or given element is not a step
// Presentation not initialized or given element is not a step
return false; return false;
} }
@@ -434,20 +441,21 @@
// So, as a lousy (and lazy) workaround we will make the page scroll back to the top // So, as a lousy (and lazy) workaround we will make the page scroll back to the top
// whenever slide is selected // whenever slide is selected
// //
// If you are reading this and know any better way to handle it, I'll be glad to hear about it! // If you are reading this and know any better way to handle it, I'll be glad to hear
window.scrollTo(0, 0); // about it!
window.scrollTo( 0, 0 );
var step = stepsData["impress-" + el.id]; var step = stepsData[ "impress-" + el.id ];
if ( activeStep ) { if ( activeStep ) {
activeStep.classList.remove("active"); activeStep.classList.remove( "active" );
body.classList.remove("impress-on-" + activeStep.id); body.classList.remove( "impress-on-" + activeStep.id );
} }
el.classList.add("active"); el.classList.add( "active" );
body.classList.add("impress-on-" + el.id); body.classList.add( "impress-on-" + el.id );
// compute target state of the canvas based on given step // Compute target state of the canvas based on given step
var target = { var target = {
rotate: { rotate: {
x: -step.rotate.x, x: -step.rotate.x,
@@ -470,20 +478,20 @@
// with scaling down and move and rotation are delayed. // with scaling down and move and rotation are delayed.
var zoomin = target.scale >= currentState.scale; var zoomin = target.scale >= currentState.scale;
duration = toNumber(duration, config.transitionDuration); duration = toNumber( duration, config.transitionDuration );
var delay = (duration / 2); var delay = ( duration / 2 );
// if the same step is re-selected, force computing window scaling, // If the same step is re-selected, force computing window scaling,
// because it is likely to be caused by window resize // because it is likely to be caused by window resize
if (el === activeStep) { if ( el === activeStep ) {
windowScale = computeWindowScale(config); windowScale = computeWindowScale( config );
} }
var targetScale = target.scale * windowScale; var targetScale = target.scale * windowScale;
// trigger leave of currently active element (if it's not the same step again) // Trigger leave of currently active element (if it's not the same step again)
if (activeStep && activeStep !== el) { if ( activeStep && activeStep !== el ) {
onStepLeave(activeStep); onStepLeave( activeStep );
} }
// Now we alter transforms of `root` and `canvas` to trigger transitions. // Now we alter transforms of `root` and `canvas` to trigger transitions.
@@ -494,74 +502,86 @@
// Transitions on them are triggered with different delays (to make // Transitions on them are triggered with different delays (to make
// visually nice and 'natural' looking transitions), so we need to know // visually nice and 'natural' looking transitions), so we need to know
// that both of them are finished. // that both of them are finished.
css(root, { css( root, {
// to keep the perspective look similar for different scales
// To keep the perspective look similar for different scales
// we need to 'scale' the perspective, too // we need to 'scale' the perspective, too
transform: perspective( config.perspective / targetScale ) + scale( targetScale ), transform: perspective( config.perspective / targetScale ) + scale( targetScale ),
transitionDuration: duration + "ms", transitionDuration: duration + "ms",
transitionDelay: (zoomin ? delay : 0) + "ms" transitionDelay: ( zoomin ? delay : 0 ) + "ms"
}); } );
css(canvas, { css( canvas, {
transform: rotate(target.rotate, true) + translate(target.translate), transform: rotate( target.rotate, true ) + translate( target.translate ),
transitionDuration: duration + "ms", transitionDuration: duration + "ms",
transitionDelay: (zoomin ? 0 : delay) + "ms" transitionDelay: ( zoomin ? 0 : delay ) + "ms"
}); } );
// Here is a tricky part... // Here is a tricky part...
// //
// If there is no change in scale or no change in rotation and translation, it means there was actually // If there is no change in scale or no change in rotation and translation, it means
// no delay - because there was no transition on `root` or `canvas` elements. // there was actually no delay - because there was no transition on `root` or `canvas`
// We want to trigger `impress:stepenter` event in the correct moment, so here we compare the current // elements. We want to trigger `impress:stepenter` event in the correct moment, so
// and target values to check if delay should be taken into account. // here we compare the current and target values to check if delay should be taken into
// account.
// //
// I know that this `if` statement looks scary, but it's pretty simple when you know what is going on // I know that this `if` statement looks scary, but it's pretty simple when you know
// what is going on
// - it's simply comparing all the values. // - it's simply comparing all the values.
if ( currentState.scale === target.scale || if ( currentState.scale === target.scale ||
(currentState.rotate.x === target.rotate.x && currentState.rotate.y === target.rotate.y && ( currentState.rotate.x === target.rotate.x &&
currentState.rotate.z === target.rotate.z && currentState.translate.x === target.translate.x && currentState.rotate.y === target.rotate.y &&
currentState.translate.y === target.translate.y && currentState.translate.z === target.translate.z) ) { currentState.rotate.z === target.rotate.z &&
currentState.translate.x === target.translate.x &&
currentState.translate.y === target.translate.y &&
currentState.translate.z === target.translate.z ) ) {
delay = 0; delay = 0;
} }
// store current state // Store current state
currentState = target; currentState = target;
activeStep = el; activeStep = el;
// And here is where we trigger `impress:stepenter` event. // And here is where we trigger `impress:stepenter` event.
// We simply set up a timeout to fire it taking transition duration (and possible delay) into account. // We simply set up a timeout to fire it taking transition duration
// (and possible delay) into account.
// //
// I really wanted to make it in more elegant way. The `transitionend` event seemed to be the best way // I really wanted to make it in more elegant way. The `transitionend` event seemed to
// to do it, but the fact that I'm using transitions on two separate elements and that the `transitionend` // be the best way to do it, but the fact that I'm using transitions on two separate
// event is only triggered when there was a transition (change in the values) caused some bugs and // elements and that the `transitionend` event is only triggered when there was a
// made the code really complicated, cause I had to handle all the conditions separately. And it still // transition (change in the values) caused some bugs and made the code really
// needed a `setTimeout` fallback for the situations when there is no transition at all. // complicated, cause I had to handle all the conditions separately. And it still
// So I decided that I'd rather make the code simpler than use shiny new `transitionend`. // needed a `setTimeout` fallback for the situations when there is no transition at
// all.
// So I decided that I'd rather make the code simpler than use shiny new
// `transitionend`.
// //
// If you want learn something interesting and see how it was done with `transitionend` go back to // If you want learn something interesting and see how it was done with `transitionend`
// version 0.5.2 of impress.js: http://github.com/bartaz/impress.js/blob/0.5.2/js/impress.js // go back to
window.clearTimeout(stepEnterTimeout); // version 0.5.2 of impress.js:
stepEnterTimeout = window.setTimeout(function() { // http://github.com/bartaz/impress.js/blob/0.5.2/js/impress.js
onStepEnter(activeStep); window.clearTimeout( stepEnterTimeout );
}, duration + delay); stepEnterTimeout = window.setTimeout( function() {
onStepEnter( activeStep );
}, duration + delay );
return el; return el;
}; };
// `prev` API function goes to previous step (in document order) // `prev` API function goes to previous step (in document order)
var prev = function () { var prev = function() {
var prev = steps.indexOf( activeStep ) - 1; var prev = steps.indexOf( activeStep ) - 1;
prev = prev >= 0 ? steps[ prev ] : steps[ steps.length-1 ]; prev = prev >= 0 ? steps[ prev ] : steps[ steps.length - 1 ];
return goto(prev); return goto( prev );
}; };
// `next` API function goes to next step (in document order) // `next` API function goes to next step (in document order)
var next = function () { var next = function() {
var next = steps.indexOf( activeStep ) + 1; var next = steps.indexOf( activeStep ) + 1;
next = next < steps.length ? steps[ next ] : steps[ 0 ]; next = next < steps.length ? steps[ next ] : steps[ 0 ];
return goto(next); return goto( next );
}; };
// Adding some useful classes to step elements. // Adding some useful classes to step elements.
@@ -577,29 +597,30 @@
// There classes can be used in CSS to style different types of steps. // There classes can be used in CSS to style different types of steps.
// For example the `present` class can be used to trigger some custom // For example the `present` class can be used to trigger some custom
// animations when step is shown. // animations when step is shown.
root.addEventListener("impress:init", function(){ root.addEventListener( "impress:init", function() {
// STEP CLASSES // STEP CLASSES
steps.forEach(function (step) { steps.forEach( function( step ) {
step.classList.add("future"); step.classList.add( "future" );
}); } );
root.addEventListener("impress:stepenter", function (event) { root.addEventListener( "impress:stepenter", function( event ) {
event.target.classList.remove("past"); event.target.classList.remove( "past" );
event.target.classList.remove("future"); event.target.classList.remove( "future" );
event.target.classList.add("present"); event.target.classList.add( "present" );
}, false); }, false );
root.addEventListener("impress:stepleave", function (event) { root.addEventListener( "impress:stepleave", function( event ) {
event.target.classList.remove("present"); event.target.classList.remove( "present" );
event.target.classList.add("past"); event.target.classList.add( "past" );
}, false); }, false );
}, false); }, false );
// Adding hash change support. // Adding hash change support.
root.addEventListener("impress:init", function(){ root.addEventListener( "impress:init", function() {
// last hash detected // Last hash detected
var lastHash = ""; var lastHash = "";
// `#/step-id` is used instead of `#step-id` to prevent default browser // `#/step-id` is used instead of `#step-id` to prevent default browser
@@ -608,42 +629,43 @@
// And it has to be set after animation finishes, because in Chrome it // And it has to be set after animation finishes, because in Chrome it
// makes transtion laggy. // makes transtion laggy.
// BUG: http://code.google.com/p/chromium/issues/detail?id=62820 // BUG: http://code.google.com/p/chromium/issues/detail?id=62820
root.addEventListener("impress:stepenter", function (event) { root.addEventListener( "impress:stepenter", function( event ) {
window.location.hash = lastHash = "#/" + event.target.id; window.location.hash = lastHash = "#/" + event.target.id;
}, false); }, false );
window.addEventListener( "hashchange", function() {
window.addEventListener("hashchange", function () {
// When the step is entered hash in the location is updated // When the step is entered hash in the location is updated
// (just few lines above from here), so the hash change is // (just few lines above from here), so the hash change is
// triggered and we would call `goto` again on the same element. // triggered and we would call `goto` again on the same element.
// //
// To avoid this we store last entered hash and compare. // To avoid this we store last entered hash and compare.
if (window.location.hash !== lastHash) { if ( window.location.hash !== lastHash ) {
goto( getElementFromHash() ); goto( getElementFromHash() );
} }
}, false); }, false );
// START // START
// by selecting step defined in url or first step of the presentation // by selecting step defined in url or first step of the presentation
goto(getElementFromHash() || steps[0], 0); goto( getElementFromHash() || steps[ 0 ], 0 );
}, false); }, false );
body.classList.add("impress-disabled"); body.classList.add( "impress-disabled" );
// store and return API for given impress.js root element // Store and return API for given impress.js root element
return (roots[ "impress-root-" + rootId ] = { return ( roots[ "impress-root-" + rootId ] = {
init: init, init: init,
goto: goto, goto: goto,
next: next, next: next,
prev: prev prev: prev
}); } );
}; };
// flag that can be used in JS to check if browser have passed the support test // Flag that can be used in JS to check if browser have passed the support test
impress.supported = impressSupported; impress.supported = impressSupported;
})(document, window); } )( document, window );
// NAVIGATION EVENTS // NAVIGATION EVENTS
@@ -653,24 +675,25 @@
// //
// In future I think about moving it to make them optional, move to separate files // In future I think about moving it to make them optional, move to separate files
// and treat more like a 'plugins'. // and treat more like a 'plugins'.
(function ( document, window ) { ( function( document, window ) {
'use strict'; "use strict";
// throttling function calls, by Remy Sharp // Throttling function calls, by Remy Sharp
// http://remysharp.com/2010/07/21/throttling-function-calls/ // http://remysharp.com/2010/07/21/throttling-function-calls/
var throttle = function (fn, delay) { var throttle = function( fn, delay ) {
var timer = null; var timer = null;
return function () { return function() {
var context = this, args = arguments; var context = this, args = arguments;
clearTimeout(timer); clearTimeout( timer );
timer = setTimeout(function () { timer = setTimeout( function() {
fn.apply(context, args); fn.apply( context, args );
}, delay); }, delay );
}; };
}; };
// wait for impress.js to be initialized // Wait for impress.js to be initialized
document.addEventListener("impress:init", function (event) { document.addEventListener( "impress:init", function( event ) {
// Getting API from event data. // Getting API from event data.
// So you don't event need to know what is the id of the root element // So you don't event need to know what is the id of the root element
// or anything. `impress:init` event data gives you everything you // or anything. `impress:init` event data gives you everything you
@@ -680,11 +703,13 @@
// KEYBOARD NAVIGATION HANDLERS // KEYBOARD NAVIGATION HANDLERS
// Prevent default keydown action when one of supported key is pressed. // Prevent default keydown action when one of supported key is pressed.
document.addEventListener("keydown", function ( event ) { document.addEventListener( "keydown", function( event ) {
if ( event.keyCode === 9 || ( event.keyCode >= 32 && event.keyCode <= 34 ) || (event.keyCode >= 37 && event.keyCode <= 40) ) { if ( event.keyCode === 9 ||
( event.keyCode >= 32 && event.keyCode <= 34 ) ||
( event.keyCode >= 37 && event.keyCode <= 40 ) ) {
event.preventDefault(); event.preventDefault();
} }
}, false); }, false );
// Trigger impress action (next or prev) on keyup. // Trigger impress action (next or prev) on keyup.
@@ -701,76 +726,81 @@
// positioning. I didn't want to just prevent this default action, so I used [tab] // positioning. I didn't want to just prevent this default action, so I used [tab]
// as another way to moving to next step... And yes, I know that for the sake of // as another way to moving to next step... And yes, I know that for the sake of
// consistency I should add [shift+tab] as opposite action... // consistency I should add [shift+tab] as opposite action...
document.addEventListener("keyup", function ( event ) { document.addEventListener( "keyup", function( event ) {
if ( event.shiftKey || event.altKey || event.ctrlKey || event.metaKey ){ if ( event.shiftKey || event.altKey || event.ctrlKey || event.metaKey ) {
return; return;
} }
if ( event.keyCode === 9 || ( event.keyCode >= 32 && event.keyCode <= 34 ) || (event.keyCode >= 37 && event.keyCode <= 40) ) { if ( event.keyCode === 9 ||
switch( event.keyCode ) { ( event.keyCode >= 32 && event.keyCode <= 34 ) ||
case 33: // pg up ( event.keyCode >= 37 && event.keyCode <= 40 ) ) {
case 37: // left switch ( event.keyCode ) {
case 38: // up case 33: // Page up
case 37: // Left
case 38: // Up
api.prev(); api.prev();
break; break;
case 9: // tab case 9: // Tab
case 32: // space case 32: // Space
case 34: // pg down case 34: // Page down
case 39: // right case 39: // Right
case 40: // down case 40: // Down
api.next(); api.next();
break; break;
} }
event.preventDefault(); event.preventDefault();
} }
}, false); }, false );
// delegated handler for clicking on the links to presentation steps // Delegated handler for clicking on the links to presentation steps
document.addEventListener("click", function ( event ) { document.addEventListener( "click", function( event ) {
// event delegation with "bubbling"
// check if event target (or any of its parents is a link) // Event delegation with "bubbling"
// Check if event target (or any of its parents is a link)
var target = event.target; var target = event.target;
while ( (target.tagName !== "A") && while ( ( target.tagName !== "A" ) &&
(target !== document.documentElement) ) { ( target !== document.documentElement ) ) {
target = target.parentNode; target = target.parentNode;
} }
if ( target.tagName === "A" ) { if ( target.tagName === "A" ) {
var href = target.getAttribute("href"); var href = target.getAttribute( "href" );
// if it's a link to presentation step, target this step // If it's a link to presentation step, target this step
if ( href && href[0] === '#' ) { if ( href && href[ 0 ] === "#" ) {
target = document.getElementById( href.slice(1) ); target = document.getElementById( href.slice( 1 ) );
} }
} }
if ( api.goto(target) ) { if ( api.goto( target ) ) {
event.stopImmediatePropagation(); event.stopImmediatePropagation();
event.preventDefault(); event.preventDefault();
} }
}, false); }, false );
// delegated handler for clicking on step elements // Delegated handler for clicking on step elements
document.addEventListener("click", function ( event ) { document.addEventListener( "click", function( event ) {
var target = event.target; var target = event.target;
// find closest step element that is not active
while ( !(target.classList.contains("step") && !target.classList.contains("active")) && // Find closest step element that is not active
(target !== document.documentElement) ) { while ( !( target.classList.contains( "step" ) &&
!target.classList.contains( "active" ) ) &&
( target !== document.documentElement ) ) {
target = target.parentNode; target = target.parentNode;
} }
if ( api.goto(target) ) { if ( api.goto( target ) ) {
event.preventDefault(); event.preventDefault();
} }
}, false); }, false );
// touch handler to detect taps on the left and right side of the screen // Touch handler to detect taps on the left and right side of the screen
// based on awesome work of @hakimel: https://github.com/hakimel/reveal.js // based on awesome work of @hakimel: https://github.com/hakimel/reveal.js
document.addEventListener("touchstart", function ( event ) { document.addEventListener( "touchstart", function( event ) {
if (event.touches.length === 1) { if ( event.touches.length === 1 ) {
var x = event.touches[0].clientX, var x = event.touches[ 0 ].clientX,
width = window.innerWidth * 0.3, width = window.innerWidth * 0.3,
result = null; result = null;
@@ -780,21 +810,22 @@
result = api.next(); result = api.next();
} }
if (result) { if ( result ) {
event.preventDefault(); event.preventDefault();
} }
} }
}, false); }, false );
// rescale presentation when window is resized // Rescale presentation when window is resized
window.addEventListener("resize", throttle(function () { window.addEventListener( "resize", throttle( function() {
// force going to active step again, to trigger rescaling
api.goto( document.querySelector(".step.active"), 500 );
}, 250), false);
}, false); // Force going to active step again, to trigger rescaling
api.goto( document.querySelector( ".step.active" ), 500 );
}, 250 ), false );
})(document, window); }, false );
} )( document, window );
// THAT'S ALL FOLKS! // THAT'S ALL FOLKS!
// //

31
package.json Normal file
View File

@@ -0,0 +1,31 @@
{
"name": "impress.js",
"version": "0.5.3",
"description": "It's a presentation framework based on the power of CSS3 transforms and transitions in modern browsers and inspired by the idea behind prezi.com.",
"main": "js/impress.js",
"repository": {
"type": "git",
"url": "https://github.com/impress/impress.js.git"
},
"keywords": [
"presentation",
"slides",
"slideshow",
"css3",
"transitions",
"transforms",
"browser"
],
"author": "Bartek Szopka",
"license": "MIT",
"bugs": {
"url": "https://github.com/bartaz/impress.js/issues"
},
"scripts": {
"lint": "jshint js/impress.js && jscs js/impress.js --preset=jquery"
},
"devDependencies": {
"jscs": "2.11.0",
"jshint": "2.9.1"
}
}