reveal.js 19 KB

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