reveal.js 19 KB

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