reveal.js 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663
  1. /**
  2. * Copyright (C) 2011 Hakim El Hattab, http://hakim.se
  3. *
  4. * Permission is hereby granted, free of charge, to any person obtaining a copy
  5. * of this software and associated documentation files (the "Software"), to deal
  6. * in the Software without restriction, including without limitation the rights
  7. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  8. * copies of the Software, and to permit persons to whom the Software is
  9. * furnished to do so, subject to the following conditions:
  10. *
  11. * The above copyright notice and this permission notice shall be included in
  12. * all copies or substantial portions of the Software.
  13. *
  14. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  20. * THE SOFTWARE.
  21. *
  22. * #############################################################################
  23. *
  24. * Reveal.js is an easy to use HTML based slideshow enhanced by
  25. * sexy CSS 3D transforms.
  26. *
  27. * Slides are given unique hash based URL's so that they can be
  28. * opened directly.
  29. *
  30. * Public facing methods:
  31. * - Reveal.initialize( { ... options ... } );
  32. * - Reveal.navigateTo( indexh, indexv );
  33. * - Reveal.navigateLeft();
  34. * - Reveal.navigateRight();
  35. * - Reveal.navigateUp();
  36. * - Reveal.navigateDown();
  37. *
  38. * @author Hakim El Hattab | http://hakim.se
  39. * @version 1.2
  40. */
  41. var Reveal = (function(){
  42. var HORIZONTAL_SLIDES_SELECTOR = '#reveal .slides>section',
  43. VERTICAL_SLIDES_SELECTOR = '#reveal .slides>section.present>section',
  44. // The horizontal and verical index of the currently active slide
  45. indexh = 0,
  46. indexv = 0,
  47. // Configurations options, can be overridden at initialization time
  48. config = {
  49. controls: false,
  50. progress: false,
  51. history: false,
  52. transition: 'default',
  53. theme: 'default',
  54. mouseWheel: true,
  55. rollingLinks: true
  56. },
  57. // Cached references to DOM elements
  58. dom = {},
  59. // Detect support for CSS 3D transforms
  60. supports3DTransforms = document.body.style['perspectiveProperty'] !== undefined ||
  61. document.body.style['WebkitPerspective'] !== undefined ||
  62. document.body.style['MozPerspective'] !== undefined ||
  63. document.body.style['msPerspective'] !== undefined,
  64. supports2DTransforms = document.body.style['transformProperty'] !== undefined ||
  65. document.body.style['WebkitTransform'] !== undefined ||
  66. document.body.style['MozTransform'] !== undefined ||
  67. document.body.style['msTransform'] !== undefined ||
  68. document.body.style['OTransform'] !== undefined,
  69. // Throttles mouse wheel navigation
  70. mouseWheelTimeout = 0;
  71. /**
  72. * Starts up the slideshow by applying configuration
  73. * options and binding various events.
  74. */
  75. function initialize( options ) {
  76. if( !supports2DTransforms && !supports3DTransforms ) {
  77. document.body.setAttribute( 'class', 'no-transforms' );
  78. // If the browser doesn't support transforms we won't be
  79. // using JavaScript to control the presentation
  80. return;
  81. }
  82. // Cache references to DOM elements
  83. dom.wrapper = document.querySelector( '#reveal' );
  84. dom.progress = document.querySelector( '#reveal .progress' );
  85. dom.progressbar = document.querySelector( '#reveal .progress span' );
  86. dom.controls = document.querySelector( '#reveal .controls' );
  87. dom.controlsLeft = document.querySelector( '#reveal .controls .left' );
  88. dom.controlsRight = document.querySelector( '#reveal .controls .right' );
  89. dom.controlsUp = document.querySelector( '#reveal .controls .up' );
  90. dom.controlsDown = document.querySelector( '#reveal .controls .down' );
  91. // Bind all view events
  92. document.addEventListener('keydown', onDocumentKeyDown, false);
  93. document.addEventListener('touchstart', onDocumentTouchStart, false);
  94. window.addEventListener('hashchange', onWindowHashChange, false);
  95. dom.controlsLeft.addEventListener('click', preventAndForward( navigateLeft ), false);
  96. dom.controlsRight.addEventListener('click', preventAndForward( navigateRight ), false);
  97. dom.controlsUp.addEventListener('click', preventAndForward( navigateUp ), false);
  98. dom.controlsDown.addEventListener('click', preventAndForward( navigateDown ), false);
  99. // Copy options over to our config object
  100. extend( config, options );
  101. // Fall back on the 2D transform theme 'linear'
  102. if( supports3DTransforms === false ) {
  103. config.transition = 'linear';
  104. }
  105. if( config.controls ) {
  106. dom.controls.style.display = 'block';
  107. }
  108. if( config.progress ) {
  109. dom.progress.style.display = 'block';
  110. }
  111. if( config.transition !== 'default' ) {
  112. dom.wrapper.classList.add( config.transition );
  113. }
  114. if( config.theme !== 'default' ) {
  115. dom.wrapper.classList.add( config.theme );
  116. }
  117. if( config.mouseWheel ) {
  118. document.addEventListener('DOMMouseScroll', onDocumentMouseScroll, false); // FF
  119. document.addEventListener('mousewheel', onDocumentMouseScroll, false);
  120. }
  121. if( config.rollingLinks ) {
  122. // Add some 3D magic to our anchors
  123. linkify();
  124. }
  125. // Read the initial hash
  126. readURL();
  127. }
  128. /**
  129. * Extend object a with the properties of object b.
  130. * If there's a conflict, object b takes precedence.
  131. */
  132. function extend( a, b ) {
  133. for( var i in b ) {
  134. a[ i ] = b[ i ];
  135. }
  136. }
  137. /**
  138. * Prevents an events defaults behavior calls the
  139. * specified delegate.
  140. *
  141. * @param {Function} delegate The method to call
  142. * after the wrapper has been executed
  143. */
  144. function preventAndForward( delegate ) {
  145. return function( event ) {
  146. event.preventDefault();
  147. delegate.call();
  148. }
  149. }
  150. /**
  151. * Handler for the document level 'keydown' event.
  152. *
  153. * @param {Object} event
  154. */
  155. function onDocumentKeyDown( event ) {
  156. // FFT: Use document.querySelector( ':focus' ) === null
  157. // instead of checking contentEditable?
  158. if( event.target.contentEditable === 'inherit' ) {
  159. if( event.keyCode >= 37 && event.keyCode <= 40 ) {
  160. switch( event.keyCode ) {
  161. case 37: navigateLeft(); break; // left
  162. case 39: navigateRight(); break; // right
  163. case 38: navigateUp(); break; // up
  164. case 40: navigateDown(); break; // down
  165. }
  166. slide();
  167. event.preventDefault();
  168. }
  169. // Space bar
  170. else if ( event.keyCode === 32 && supports3DTransforms ) {
  171. if( overviewIsActive() ) {
  172. deactivateOverview();
  173. }
  174. else {
  175. activateOverview();
  176. }
  177. event.preventDefault();
  178. }
  179. }
  180. }
  181. /**
  182. * Handler for the document level 'touchstart' event.
  183. *
  184. * This enables very basic tap interaction for touch
  185. * devices. Added mainly for performance testing of 3D
  186. * transforms on iOS but was so happily surprised with
  187. * how smoothly it runs so I left it in here. Apple +1
  188. *
  189. * @param {Object} event
  190. */
  191. function onDocumentTouchStart( event ) {
  192. // We're only interested in one point taps
  193. if (event.touches.length === 1) {
  194. // Never prevent taps on anchors and images
  195. if( event.target.tagName.toLowerCase() === 'a' || event.target.tagName.toLowerCase() === 'img' ) {
  196. return;
  197. }
  198. event.preventDefault();
  199. var point = {
  200. x: event.touches[0].clientX,
  201. y: event.touches[0].clientY
  202. };
  203. // Define the extent of the areas that may be tapped
  204. // to navigate
  205. var wt = window.innerWidth * 0.3;
  206. var ht = window.innerHeight * 0.3;
  207. if( point.x < wt ) {
  208. navigateLeft();
  209. }
  210. else if( point.x > window.innerWidth - wt ) {
  211. navigateRight();
  212. }
  213. else if( point.y < ht ) {
  214. navigateUp();
  215. }
  216. else if( point.y > window.innerHeight - ht ) {
  217. navigateDown();
  218. }
  219. slide();
  220. }
  221. }
  222. /**
  223. * Handles mouse wheel scrolling, throttled to avoid
  224. * skipping multiple slides.
  225. */
  226. function onDocumentMouseScroll( event ){
  227. clearTimeout( mouseWheelTimeout );
  228. mouseWheelTimeout = setTimeout( function() {
  229. var delta = event.detail || -event.wheelDelta;
  230. if( delta > 0 ) {
  231. availableRoutes().down ? navigateDown() : navigateRight();
  232. }
  233. else {
  234. availableRoutes().up ? navigateUp() : navigateLeft();
  235. }
  236. }, 100 );
  237. }
  238. /**
  239. * Handler for the window level 'hashchange' event.
  240. *
  241. * @param {Object} event
  242. */
  243. function onWindowHashChange( event ) {
  244. readURL();
  245. }
  246. /**
  247. * Wrap all links in 3D goodness.
  248. */
  249. function linkify() {
  250. if( supports3DTransforms ) {
  251. var nodes = document.querySelectorAll( '#reveal .slides section a:not(.image)' );
  252. for( var i = 0, len = nodes.length; i < len; i++ ) {
  253. var node = nodes[i];
  254. if( node.textContent && !node.querySelector( 'img' ) && ( !node.className || !hasClass( node, 'roll' ) ) ) {
  255. node.classList.add( 'roll' );
  256. node.innerHTML = '<span data-title="'+ node.text +'">' + node.innerHTML + '</span>';
  257. }
  258. };
  259. }
  260. }
  261. /**
  262. * Displays the overview of slides (quick nav) by
  263. * scaling down and arranging all slide elements.
  264. *
  265. * Experimental feature, might be dropped if perf
  266. * can't be improved.
  267. */
  268. function activateOverview() {
  269. dom.wrapper.classList.add( 'overview' );
  270. var horizontalSlides = Array.prototype.slice.call( document.querySelectorAll( HORIZONTAL_SLIDES_SELECTOR ) );
  271. for( var i = 0, len1 = horizontalSlides.length; i < len1; i++ ) {
  272. var hslide = horizontalSlides[i],
  273. htransform = 'translateZ(-2500px) translate(' + ( ( i - indexh ) * 105 ) + '%, 0%)';
  274. hslide.setAttribute( 'data-index-h', i );
  275. hslide.style.display = 'block';
  276. hslide.style.WebkitTransform = htransform;
  277. hslide.style.MozTransform = htransform;
  278. hslide.style.msTransform = htransform;
  279. hslide.style.OTransform = htransform;
  280. hslide.style.transform = htransform;
  281. if( !hslide.classList.contains( 'stack' ) ) {
  282. // Navigate to this slide on click
  283. hslide.addEventListener( 'click', onOverviewSlideClicked, true );
  284. }
  285. var verticalSlides = Array.prototype.slice.call( hslide.querySelectorAll( 'section' ) );
  286. for( var j = 0, len2 = verticalSlides.length; j < len2; j++ ) {
  287. var vslide = verticalSlides[j],
  288. vtransform = 'translate(0%, ' + ( ( j - indexv ) * 105 ) + '%)';
  289. vslide.setAttribute( 'data-index-h', i );
  290. vslide.setAttribute( 'data-index-v', j );
  291. vslide.style.display = 'block';
  292. vslide.style.WebkitTransform = vtransform;
  293. vslide.style.MozTransform = vtransform;
  294. vslide.style.msTransform = vtransform;
  295. vslide.style.OTransform = vtransform;
  296. vslide.style.transform = vtransform;
  297. // Navigate to this slide on click
  298. vslide.addEventListener( 'click', onOverviewSlideClicked, true );
  299. }
  300. }
  301. }
  302. /**
  303. * Exits the slide overview and enters the currently
  304. * active slide.
  305. */
  306. function deactivateOverview() {
  307. dom.wrapper.classList.remove( 'overview' );
  308. var slides = Array.prototype.slice.call( document.querySelectorAll( '#reveal .slides section' ) );
  309. for( var i = 0, len = slides.length; i < len; i++ ) {
  310. var element = slides[i];
  311. // Resets all transforms to use the external styles
  312. element.style.WebkitTransform = '';
  313. element.style.MozTransform = '';
  314. element.style.msTransform = '';
  315. element.style.OTransform = '';
  316. element.style.transform = '';
  317. element.removeEventListener( 'click', onOverviewSlideClicked );
  318. }
  319. slide();
  320. }
  321. /**
  322. * Checks if the overview is currently active.
  323. *
  324. * @return {Boolean} true if the overview is active,
  325. * false otherwise
  326. */
  327. function overviewIsActive() {
  328. return dom.wrapper.classList.contains( 'overview' );
  329. }
  330. /**
  331. * Invoked when a slide is and we're in the overview.
  332. */
  333. function onOverviewSlideClicked( event ) {
  334. // TODO There's a bug here where the event listeners are not
  335. // removed after deactivating the overview.
  336. if( overviewIsActive() ) {
  337. event.preventDefault();
  338. deactivateOverview();
  339. indexh = this.getAttribute( 'data-index-h' );
  340. indexv = this.getAttribute( 'data-index-v' );
  341. slide();
  342. }
  343. }
  344. /**
  345. * Updates one dimension of slides by showing the slide
  346. * with the specified index.
  347. *
  348. * @param {String} selector A CSS selector that will fetch
  349. * the group of slides we are working with
  350. * @param {Number} index The index of the slide that should be
  351. * shown
  352. *
  353. * @return {Number} The index of the slide that is now shown,
  354. * might differ from the passed in index if it was out of
  355. * bounds.
  356. */
  357. function updateSlides( selector, index ) {
  358. // Select all slides and convert the NodeList result to
  359. // an array
  360. var slides = Array.prototype.slice.call( document.querySelectorAll( selector ) );
  361. if( slides.length ) {
  362. // Enforce max and minimum index bounds
  363. index = Math.max(Math.min(index, slides.length - 1), 0);
  364. slides[index].className = 'present';
  365. for( var i = 0; i < slides.length; i++ ) {
  366. var slide = slides[i];
  367. // Optimization; hide all slides that are three or more steps
  368. // away from the present slide
  369. if( overviewIsActive() === false ) {
  370. slide.style.display = Math.abs( index - i ) > 3 ? 'none' : 'block';
  371. }
  372. if( i < index ) {
  373. // Any element previous to index is given the 'past' class
  374. slide.className = 'past';
  375. }
  376. else if( i > index ) {
  377. // Any element subsequent to index is given the 'future' class
  378. slide.className = 'future';
  379. }
  380. // If this element contains vertical slides
  381. if( slide.querySelector( 'section' ) ) {
  382. slide.classList.add( 'stack' );
  383. }
  384. }
  385. }
  386. else {
  387. // Since there are no slides we can't be anywhere beyond the
  388. // zeroth index
  389. index = 0;
  390. }
  391. return index;
  392. }
  393. /**
  394. * Updates the visual slides to represent the currently
  395. * set indices.
  396. */
  397. function slide() {
  398. indexh = updateSlides( HORIZONTAL_SLIDES_SELECTOR, indexh );
  399. indexv = updateSlides( VERTICAL_SLIDES_SELECTOR, indexv );
  400. // Update progress if enabled
  401. if( config.progress ) {
  402. dom.progressbar.style.width = ( indexh / ( document.querySelectorAll( HORIZONTAL_SLIDES_SELECTOR ).length - 1 ) ) * window.innerWidth + 'px';
  403. }
  404. // Close the overview if it's active
  405. if( overviewIsActive() ) {
  406. activateOverview();
  407. }
  408. updateControls();
  409. writeURL();
  410. }
  411. /**
  412. * Updates the state and link pointers of the controls.
  413. */
  414. function updateControls() {
  415. var routes = availableRoutes();
  416. // Remove the 'enabled' class from all directions
  417. [ dom.controlsLeft, dom.controlsRight, dom.controlsUp, dom.controlsDown ].forEach( function( node ) {
  418. node.classList.remove( 'enabled' );
  419. } )
  420. if( routes.left ) dom.controlsLeft.classList.add( 'enabled' );
  421. if( routes.right ) dom.controlsRight.classList.add( 'enabled' );
  422. if( routes.up ) dom.controlsUp.classList.add( 'enabled' );
  423. if( routes.down ) dom.controlsDown.classList.add( 'enabled' );
  424. }
  425. /**
  426. * Determine what available routes there are for navigation.
  427. *
  428. * @return {Object} containing four booleans: left/right/up/down
  429. */
  430. function availableRoutes() {
  431. var horizontalSlides = document.querySelectorAll( HORIZONTAL_SLIDES_SELECTOR );
  432. var verticalSlides = document.querySelectorAll( VERTICAL_SLIDES_SELECTOR );
  433. return {
  434. left: indexh > 0,
  435. right: indexh < horizontalSlides.length - 1,
  436. up: indexv > 0,
  437. down: indexv < verticalSlides.length - 1
  438. };
  439. }
  440. /**
  441. * Reads the current URL (hash) and navigates accordingly.
  442. */
  443. function readURL() {
  444. // Break the hash down to separate components
  445. var bits = window.location.hash.slice(2).split('/');
  446. // Read the index components of the hash
  447. indexh = bits[0] ? parseInt( bits[0] ) : 0;
  448. indexv = bits[1] ? parseInt( bits[1] ) : 0;
  449. navigateTo( indexh, indexv );
  450. }
  451. /**
  452. * Updates the page URL (hash) to reflect the current
  453. * state.
  454. */
  455. function writeURL() {
  456. if( config.history ) {
  457. var url = '/';
  458. // Only include the minimum possible number of components in
  459. // the URL
  460. if( indexh > 0 || indexv > 0 ) url += indexh;
  461. if( indexv > 0 ) url += '/' + indexv;
  462. window.location.hash = url;
  463. }
  464. }
  465. /**
  466. * Navigate to the next slide fragment.
  467. *
  468. * @return {Boolean} true if there was a next fragment,
  469. * false otherwise
  470. */
  471. function nextFragment() {
  472. // Vertical slides:
  473. if( document.querySelector( VERTICAL_SLIDES_SELECTOR + '.present' ) ) {
  474. var verticalFragments = document.querySelectorAll( VERTICAL_SLIDES_SELECTOR + '.present .fragment:not(.visible)' );
  475. if( verticalFragments.length ) {
  476. verticalFragments[0].classList.add( 'visible' );
  477. return true;
  478. }
  479. }
  480. // Horizontal slides:
  481. else {
  482. var horizontalFragments = document.querySelectorAll( HORIZONTAL_SLIDES_SELECTOR + '.present .fragment:not(.visible)' );
  483. if( horizontalFragments.length ) {
  484. horizontalFragments[0].classList.add( 'visible' );
  485. return true;
  486. }
  487. }
  488. return false;
  489. }
  490. /**
  491. * Navigate to the previous slide fragment.
  492. *
  493. * @return {Boolean} true if there was a previous fragment,
  494. * false otherwise
  495. */
  496. function previousFragment() {
  497. // Vertical slides:
  498. if( document.querySelector( VERTICAL_SLIDES_SELECTOR + '.present' ) ) {
  499. var verticalFragments = document.querySelectorAll( VERTICAL_SLIDES_SELECTOR + '.present .fragment.visible' );
  500. if( verticalFragments.length ) {
  501. verticalFragments[ verticalFragments.length - 1 ].classList.remove( 'visible' );
  502. return true;
  503. }
  504. }
  505. // Horizontal slides:
  506. else {
  507. var horizontalFragments = document.querySelectorAll( HORIZONTAL_SLIDES_SELECTOR + '.present .fragment.visible' );
  508. if( horizontalFragments.length ) {
  509. horizontalFragments[ horizontalFragments.length - 1 ].classList.remove( 'visible' );
  510. return true;
  511. }
  512. }
  513. return false;
  514. }
  515. /**
  516. * Triggers a navigation to the specified indices.
  517. *
  518. * @param {Number} h The horizontal index of the slide to show
  519. * @param {Number} v The vertical index of the slide to show
  520. */
  521. function navigateTo( h, v ) {
  522. indexh = h === undefined ? indexh : h;
  523. indexv = v === undefined ? indexv : v;
  524. slide();
  525. }
  526. function navigateLeft() {
  527. // Prioritize hiding fragments
  528. if( overviewIsActive() || previousFragment() === false ) {
  529. indexh --;
  530. indexv = 0;
  531. slide();
  532. }
  533. }
  534. function navigateRight() {
  535. // Prioritize revealing fragments
  536. if( overviewIsActive() || nextFragment() === false ) {
  537. indexh ++;
  538. indexv = 0;
  539. slide();
  540. }
  541. }
  542. function navigateUp() {
  543. // Prioritize hiding fragments
  544. if( overviewIsActive() || previousFragment() === false ) {
  545. indexv --;
  546. slide();
  547. }
  548. }
  549. function navigateDown() {
  550. // Prioritize revealing fragments
  551. if( overviewIsActive() || nextFragment() === false ) {
  552. indexv ++;
  553. slide();
  554. }
  555. }
  556. // Expose some methods publicly
  557. return {
  558. initialize: initialize,
  559. navigateTo: navigateTo,
  560. navigateLeft: navigateLeft,
  561. navigateRight: navigateRight,
  562. navigateUp: navigateUp,
  563. navigateDown: navigateDown
  564. };
  565. })();