reveal.js 18 KB

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