reveal.js 19 KB

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