UNPKG

reveal.js

Version:

The HTML Presentation Framework

1,847 lines (1,447 loc) 80.8 kB
import SlideContent from './controllers/slidecontent.js' import SlideNumber from './controllers/slidenumber.js' import JumpToSlide from './controllers/jumptoslide.js' import Backgrounds from './controllers/backgrounds.js' import AutoAnimate from './controllers/autoanimate.js' import ScrollView from './controllers/scrollview.js' import PrintView from './controllers/printview.js' import Fragments from './controllers/fragments.js' import Overview from './controllers/overview.js' import Keyboard from './controllers/keyboard.js' import Location from './controllers/location.js' import Controls from './controllers/controls.js' import Progress from './controllers/progress.js' import Pointer from './controllers/pointer.js' import Plugins from './controllers/plugins.js' import Touch from './controllers/touch.js' import Focus from './controllers/focus.js' import Notes from './controllers/notes.js' import Playback from './components/playback.js' import defaultConfig from './config.js' import * as Util from './utils/util.js' import * as Device from './utils/device.js' import { SLIDES_SELECTOR, HORIZONTAL_SLIDES_SELECTOR, VERTICAL_SLIDES_SELECTOR, POST_MESSAGE_METHOD_BLACKLIST } from './utils/constants.js' // The reveal.js version export const VERSION = '5.0.1'; /** * reveal.js * https://revealjs.com * MIT licensed * * Copyright (C) 2011-2022 Hakim El Hattab, https://hakim.se */ export default function( revealElement, options ) { // Support initialization with no args, one arg // [options] or two args [revealElement, options] if( arguments.length < 2 ) { options = arguments[0]; revealElement = document.querySelector( '.reveal' ); } const Reveal = {}; // Configuration defaults, can be overridden at initialization time let config = {}, // Flags if reveal.js is loaded (has dispatched the 'ready' event) ready = false, // The horizontal and vertical index of the currently active slide indexh, indexv, // The previous and current slide HTML elements previousSlide, currentSlide, // Remember which directions that the user has navigated towards navigationHistory = { hasNavigatedHorizontally: false, hasNavigatedVertically: false }, // Slides may have a data-state attribute which we pick up and apply // as a class to the body. This list contains the combined state of // all current slides. state = [], // The current scale of the presentation (see width/height config) scale = 1, // CSS transform that is currently applied to the slides container, // split into two groups slidesTransform = { layout: '', overview: '' }, // Cached references to DOM elements dom = {}, // Flags if the interaction event listeners are bound eventsAreBound = false, // The current slide transition state; idle or running transition = 'idle', // The current auto-slide duration autoSlide = 0, // Auto slide properties autoSlidePlayer, autoSlideTimeout = 0, autoSlideStartTime = -1, autoSlidePaused = false, // Controllers for different aspects of our presentation. They're // all given direct references to this Reveal instance since there // may be multiple presentations running in parallel. slideContent = new SlideContent( Reveal ), slideNumber = new SlideNumber( Reveal ), jumpToSlide = new JumpToSlide( Reveal ), autoAnimate = new AutoAnimate( Reveal ), backgrounds = new Backgrounds( Reveal ), scrollView = new ScrollView( Reveal ), printView = new PrintView( Reveal ), fragments = new Fragments( Reveal ), overview = new Overview( Reveal ), keyboard = new Keyboard( Reveal ), location = new Location( Reveal ), controls = new Controls( Reveal ), progress = new Progress( Reveal ), pointer = new Pointer( Reveal ), plugins = new Plugins( Reveal ), focus = new Focus( Reveal ), touch = new Touch( Reveal ), notes = new Notes( Reveal ); /** * Starts up the presentation. */ function initialize( initOptions ) { if( !revealElement ) throw 'Unable to find presentation root (<div class="reveal">).'; // Cache references to key DOM elements dom.wrapper = revealElement; dom.slides = revealElement.querySelector( '.slides' ); if( !dom.slides ) throw 'Unable to find slides container (<div class="slides">).'; // Compose our config object in order of increasing precedence: // 1. Default reveal.js options // 2. Options provided via Reveal.configure() prior to // initialization // 3. Options passed to the Reveal constructor // 4. Options passed to Reveal.initialize // 5. Query params config = { ...defaultConfig, ...config, ...options, ...initOptions, ...Util.getQueryHash() }; // Legacy support for the ?print-pdf query if( /print-pdf/gi.test( window.location.search ) ) { config.view = 'print'; } setViewport(); // Force a layout when the whole page, incl fonts, has loaded window.addEventListener( 'load', layout, false ); // Register plugins and load dependencies, then move on to #start() plugins.load( config.plugins, config.dependencies ).then( start ); return new Promise( resolve => Reveal.on( 'ready', resolve ) ); } /** * Encase the presentation in a reveal.js viewport. The * extent of the viewport differs based on configuration. */ function setViewport() { // Embedded decks use the reveal element as their viewport if( config.embedded === true ) { dom.viewport = Util.closest( revealElement, '.reveal-viewport' ) || revealElement; } // Full-page decks use the body as their viewport else { dom.viewport = document.body; document.documentElement.classList.add( 'reveal-full-page' ); } dom.viewport.classList.add( 'reveal-viewport' ); } /** * Starts up reveal.js by binding input events and navigating * to the current URL deeplink if there is one. */ function start() { ready = true; // Remove slides hidden with data-visibility removeHiddenSlides(); // Make sure we've got all the DOM elements we need setupDOM(); // Listen to messages posted to this window setupPostMessage(); // Prevent the slides from being scrolled out of view setupScrollPrevention(); // Adds bindings for fullscreen mode setupFullscreen(); // Resets all vertical slides so that only the first is visible resetVerticalSlides(); // Updates the presentation to match the current configuration values configure(); // Create slide backgrounds backgrounds.update( true ); // Activate the print/scroll view if configured activateInitialView(); // Read the initial hash location.readURL(); // Notify listeners that the presentation is ready but use a 1ms // timeout to ensure it's not fired synchronously after #initialize() setTimeout( () => { // Enable transitions now that we're loaded dom.slides.classList.remove( 'no-transition' ); dom.wrapper.classList.add( 'ready' ); dispatchEvent({ type: 'ready', data: { indexh, indexv, currentSlide } }); }, 1 ); } /** * Activates the correct reveal.js view based on our config. * This is only invoked once during initialization. */ function activateInitialView() { const activatePrintView = config.view === 'print'; const activateScrollView = config.view === 'scroll' || config.view === 'reader'; if( activatePrintView || activateScrollView ) { if( activatePrintView ) { removeEventListeners(); } else { touch.unbind(); } // Avoid content flickering during layout dom.viewport.classList.add( 'loading-scroll-mode' ); if( activatePrintView ) { // The document needs to have loaded for the PDF layout // measurements to be accurate if( document.readyState === 'complete' ) { printView.activate(); } else { window.addEventListener( 'load', () => printView.activate() ); } } else { scrollView.activate(); } } } /** * Removes all slides with data-visibility="hidden". This * is done right before the rest of the presentation is * initialized. * * If you want to show all hidden slides, initialize * reveal.js with showHiddenSlides set to true. */ function removeHiddenSlides() { if( !config.showHiddenSlides ) { Util.queryAll( dom.wrapper, 'section[data-visibility="hidden"]' ).forEach( slide => { const parent = slide.parentNode; // If this slide is part of a stack and that stack will be // empty after removing the hidden slide, remove the entire // stack if( parent.childElementCount === 1 && /section/i.test( parent.nodeName ) ) { parent.remove(); } else { slide.remove(); } } ); } } /** * Finds and stores references to DOM elements which are * required by the presentation. If a required element is * not found, it is created. */ function setupDOM() { // Prevent transitions while we're loading dom.slides.classList.add( 'no-transition' ); if( Device.isMobile ) { dom.wrapper.classList.add( 'no-hover' ); } else { dom.wrapper.classList.remove( 'no-hover' ); } backgrounds.render(); slideNumber.render(); jumpToSlide.render(); controls.render(); progress.render(); notes.render(); // Overlay graphic which is displayed during the paused mode dom.pauseOverlay = Util.createSingletonNode( dom.wrapper, 'div', 'pause-overlay', config.controls ? '<button class="resume-button">Resume presentation</button>' : null ); dom.statusElement = createStatusElement(); dom.wrapper.setAttribute( 'role', 'application' ); } /** * Creates a hidden div with role aria-live to announce the * current slide content. Hide the div off-screen to make it * available only to Assistive Technologies. * * @return {HTMLElement} */ function createStatusElement() { let statusElement = dom.wrapper.querySelector( '.aria-status' ); if( !statusElement ) { statusElement = document.createElement( 'div' ); statusElement.style.position = 'absolute'; statusElement.style.height = '1px'; statusElement.style.width = '1px'; statusElement.style.overflow = 'hidden'; statusElement.style.clip = 'rect( 1px, 1px, 1px, 1px )'; statusElement.classList.add( 'aria-status' ); statusElement.setAttribute( 'aria-live', 'polite' ); statusElement.setAttribute( 'aria-atomic','true' ); dom.wrapper.appendChild( statusElement ); } return statusElement; } /** * Announces the given text to screen readers. */ function announceStatus( value ) { dom.statusElement.textContent = value; } /** * Converts the given HTML element into a string of text * that can be announced to a screen reader. Hidden * elements are excluded. */ function getStatusText( node ) { let text = ''; // Text node if( node.nodeType === 3 ) { text += node.textContent; } // Element node else if( node.nodeType === 1 ) { let isAriaHidden = node.getAttribute( 'aria-hidden' ); let isDisplayHidden = window.getComputedStyle( node )['display'] === 'none'; if( isAriaHidden !== 'true' && !isDisplayHidden ) { Array.from( node.childNodes ).forEach( child => { text += getStatusText( child ); } ); } } text = text.trim(); return text === '' ? '' : text + ' '; } /** * This is an unfortunate necessity. Some actions – such as * an input field being focused in an iframe or using the * keyboard to expand text selection beyond the bounds of * a slide – can trigger our content to be pushed out of view. * This scrolling can not be prevented by hiding overflow in * CSS (we already do) so we have to resort to repeatedly * checking if the slides have been offset :( */ function setupScrollPrevention() { setInterval( () => { if( !scrollView.isActive() && dom.wrapper.scrollTop !== 0 || dom.wrapper.scrollLeft !== 0 ) { dom.wrapper.scrollTop = 0; dom.wrapper.scrollLeft = 0; } }, 1000 ); } /** * After entering fullscreen we need to force a layout to * get our presentations to scale correctly. This behavior * is inconsistent across browsers but a force layout seems * to normalize it. */ function setupFullscreen() { document.addEventListener( 'fullscreenchange', onFullscreenChange ); document.addEventListener( 'webkitfullscreenchange', onFullscreenChange ); } /** * Registers a listener to postMessage events, this makes it * possible to call all reveal.js API methods from another * window. For example: * * revealWindow.postMessage( JSON.stringify({ * method: 'slide', * args: [ 2 ] * }), '*' ); */ function setupPostMessage() { if( config.postMessage ) { window.addEventListener( 'message', onPostMessage, false ); } } /** * Applies the configuration settings from the config * object. May be called multiple times. * * @param {object} options */ function configure( options ) { const oldConfig = { ...config } // New config options may be passed when this method // is invoked through the API after initialization if( typeof options === 'object' ) Util.extend( config, options ); // Abort if reveal.js hasn't finished loading, config // changes will be applied automatically once ready if( Reveal.isReady() === false ) return; const numberOfSlides = dom.wrapper.querySelectorAll( SLIDES_SELECTOR ).length; // The transition is added as a class on the .reveal element dom.wrapper.classList.remove( oldConfig.transition ); dom.wrapper.classList.add( config.transition ); dom.wrapper.setAttribute( 'data-transition-speed', config.transitionSpeed ); dom.wrapper.setAttribute( 'data-background-transition', config.backgroundTransition ); // Expose our configured slide dimensions as custom props dom.viewport.style.setProperty( '--slide-width', typeof config.width === 'string' ? config.width : config.width + 'px' ); dom.viewport.style.setProperty( '--slide-height', typeof config.height === 'string' ? config.height : config.height + 'px' ); if( config.shuffle ) { shuffle(); } Util.toggleClass( dom.wrapper, 'embedded', config.embedded ); Util.toggleClass( dom.wrapper, 'rtl', config.rtl ); Util.toggleClass( dom.wrapper, 'center', config.center ); // Exit the paused mode if it was configured off if( config.pause === false ) { resume(); } // Iframe link previews if( config.previewLinks ) { enablePreviewLinks(); disablePreviewLinks( '[data-preview-link=false]' ); } else { disablePreviewLinks(); enablePreviewLinks( '[data-preview-link]:not([data-preview-link=false])' ); } // Reset all changes made by auto-animations autoAnimate.reset(); // Remove existing auto-slide controls if( autoSlidePlayer ) { autoSlidePlayer.destroy(); autoSlidePlayer = null; } // Generate auto-slide controls if needed if( numberOfSlides > 1 && config.autoSlide && config.autoSlideStoppable ) { autoSlidePlayer = new Playback( dom.wrapper, () => { return Math.min( Math.max( ( Date.now() - autoSlideStartTime ) / autoSlide, 0 ), 1 ); } ); autoSlidePlayer.on( 'click', onAutoSlidePlayerClick ); autoSlidePaused = false; } // Add the navigation mode to the DOM so we can adjust styling if( config.navigationMode !== 'default' ) { dom.wrapper.setAttribute( 'data-navigation-mode', config.navigationMode ); } else { dom.wrapper.removeAttribute( 'data-navigation-mode' ); } notes.configure( config, oldConfig ); focus.configure( config, oldConfig ); pointer.configure( config, oldConfig ); controls.configure( config, oldConfig ); progress.configure( config, oldConfig ); keyboard.configure( config, oldConfig ); fragments.configure( config, oldConfig ); slideNumber.configure( config, oldConfig ); sync(); } /** * Binds all event listeners. */ function addEventListeners() { eventsAreBound = true; window.addEventListener( 'resize', onWindowResize, false ); if( config.touch ) touch.bind(); if( config.keyboard ) keyboard.bind(); if( config.progress ) progress.bind(); if( config.respondToHashChanges ) location.bind(); controls.bind(); focus.bind(); dom.slides.addEventListener( 'click', onSlidesClicked, false ); dom.slides.addEventListener( 'transitionend', onTransitionEnd, false ); dom.pauseOverlay.addEventListener( 'click', resume, false ); if( config.focusBodyOnPageVisibilityChange ) { document.addEventListener( 'visibilitychange', onPageVisibilityChange, false ); } } /** * Unbinds all event listeners. */ function removeEventListeners() { eventsAreBound = false; touch.unbind(); focus.unbind(); keyboard.unbind(); controls.unbind(); progress.unbind(); location.unbind(); window.removeEventListener( 'resize', onWindowResize, false ); dom.slides.removeEventListener( 'click', onSlidesClicked, false ); dom.slides.removeEventListener( 'transitionend', onTransitionEnd, false ); dom.pauseOverlay.removeEventListener( 'click', resume, false ); } /** * Uninitializes reveal.js by undoing changes made to the * DOM and removing all event listeners. */ function destroy() { removeEventListeners(); cancelAutoSlide(); disablePreviewLinks(); // Destroy controllers notes.destroy(); focus.destroy(); plugins.destroy(); pointer.destroy(); controls.destroy(); progress.destroy(); backgrounds.destroy(); slideNumber.destroy(); jumpToSlide.destroy(); // Remove event listeners document.removeEventListener( 'fullscreenchange', onFullscreenChange ); document.removeEventListener( 'webkitfullscreenchange', onFullscreenChange ); document.removeEventListener( 'visibilitychange', onPageVisibilityChange, false ); window.removeEventListener( 'message', onPostMessage, false ); window.removeEventListener( 'load', layout, false ); // Undo DOM changes if( dom.pauseOverlay ) dom.pauseOverlay.remove(); if( dom.statusElement ) dom.statusElement.remove(); document.documentElement.classList.remove( 'reveal-full-page' ); dom.wrapper.classList.remove( 'ready', 'center', 'has-horizontal-slides', 'has-vertical-slides' ); dom.wrapper.removeAttribute( 'data-transition-speed' ); dom.wrapper.removeAttribute( 'data-background-transition' ); dom.viewport.classList.remove( 'reveal-viewport' ); dom.viewport.style.removeProperty( '--slide-width' ); dom.viewport.style.removeProperty( '--slide-height' ); dom.slides.style.removeProperty( 'width' ); dom.slides.style.removeProperty( 'height' ); dom.slides.style.removeProperty( 'zoom' ); dom.slides.style.removeProperty( 'left' ); dom.slides.style.removeProperty( 'top' ); dom.slides.style.removeProperty( 'bottom' ); dom.slides.style.removeProperty( 'right' ); dom.slides.style.removeProperty( 'transform' ); Array.from( dom.wrapper.querySelectorAll( SLIDES_SELECTOR ) ).forEach( slide => { slide.style.removeProperty( 'display' ); slide.style.removeProperty( 'top' ); slide.removeAttribute( 'hidden' ); slide.removeAttribute( 'aria-hidden' ); } ); } /** * Adds a listener to one of our custom reveal.js events, * like slidechanged. */ function on( type, listener, useCapture ) { revealElement.addEventListener( type, listener, useCapture ); } /** * Unsubscribes from a reveal.js event. */ function off( type, listener, useCapture ) { revealElement.removeEventListener( type, listener, useCapture ); } /** * Applies CSS transforms to the slides container. The container * is transformed from two separate sources: layout and the overview * mode. * * @param {object} transforms */ function transformSlides( transforms ) { // Pick up new transforms from arguments if( typeof transforms.layout === 'string' ) slidesTransform.layout = transforms.layout; if( typeof transforms.overview === 'string' ) slidesTransform.overview = transforms.overview; // Apply the transforms to the slides container if( slidesTransform.layout ) { Util.transformElement( dom.slides, slidesTransform.layout + ' ' + slidesTransform.overview ); } else { Util.transformElement( dom.slides, slidesTransform.overview ); } } /** * Dispatches an event of the specified type from the * reveal DOM element. */ function dispatchEvent({ target=dom.wrapper, type, data, bubbles=true }) { let event = document.createEvent( 'HTMLEvents', 1, 2 ); event.initEvent( type, bubbles, true ); Util.extend( event, data ); target.dispatchEvent( event ); if( target === dom.wrapper ) { // If we're in an iframe, post each reveal.js event to the // parent window. Used by the notes plugin dispatchPostMessage( type ); } return event; } /** * Dispatches a slidechanged event. * * @param {string} origin Used to identify multiplex clients */ function dispatchSlideChanged( origin ) { dispatchEvent({ type: 'slidechanged', data: { indexh, indexv, previousSlide, currentSlide, origin } }); } /** * Dispatched a postMessage of the given type from our window. */ function dispatchPostMessage( type, data ) { if( config.postMessageEvents && window.parent !== window.self ) { let message = { namespace: 'reveal', eventName: type, state: getState() }; Util.extend( message, data ); window.parent.postMessage( JSON.stringify( message ), '*' ); } } /** * Bind preview frame links. * * @param {string} [selector=a] - selector for anchors */ function enablePreviewLinks( selector = 'a' ) { Array.from( dom.wrapper.querySelectorAll( selector ) ).forEach( element => { if( /^(http|www)/gi.test( element.getAttribute( 'href' ) ) ) { element.addEventListener( 'click', onPreviewLinkClicked, false ); } } ); } /** * Unbind preview frame links. */ function disablePreviewLinks( selector = 'a' ) { Array.from( dom.wrapper.querySelectorAll( selector ) ).forEach( element => { if( /^(http|www)/gi.test( element.getAttribute( 'href' ) ) ) { element.removeEventListener( 'click', onPreviewLinkClicked, false ); } } ); } /** * Opens a preview window for the target URL. * * @param {string} url - url for preview iframe src */ function showPreview( url ) { closeOverlay(); dom.overlay = document.createElement( 'div' ); dom.overlay.classList.add( 'overlay' ); dom.overlay.classList.add( 'overlay-preview' ); dom.wrapper.appendChild( dom.overlay ); dom.overlay.innerHTML = `<header> <a class="close" href="#"><span class="icon"></span></a> <a class="external" href="${url}" target="_blank"><span class="icon"></span></a> </header> <div class="spinner"></div> <div class="viewport"> <iframe src="${url}"></iframe> <small class="viewport-inner"> <span class="x-frame-error">Unable to load iframe. This is likely due to the site's policy (x-frame-options).</span> </small> </div>`; dom.overlay.querySelector( 'iframe' ).addEventListener( 'load', event => { dom.overlay.classList.add( 'loaded' ); }, false ); dom.overlay.querySelector( '.close' ).addEventListener( 'click', event => { closeOverlay(); event.preventDefault(); }, false ); dom.overlay.querySelector( '.external' ).addEventListener( 'click', event => { closeOverlay(); }, false ); } /** * Open or close help overlay window. * * @param {Boolean} [override] Flag which overrides the * toggle logic and forcibly sets the desired state. True means * help is open, false means it's closed. */ function toggleHelp( override ){ if( typeof override === 'boolean' ) { override ? showHelp() : closeOverlay(); } else { if( dom.overlay ) { closeOverlay(); } else { showHelp(); } } } /** * Opens an overlay window with help material. */ function showHelp() { if( config.help ) { closeOverlay(); dom.overlay = document.createElement( 'div' ); dom.overlay.classList.add( 'overlay' ); dom.overlay.classList.add( 'overlay-help' ); dom.wrapper.appendChild( dom.overlay ); let html = '<p class="title">Keyboard Shortcuts</p><br/>'; let shortcuts = keyboard.getShortcuts(), bindings = keyboard.getBindings(); html += '<table><th>KEY</th><th>ACTION</th>'; for( let key in shortcuts ) { html += `<tr><td>${key}</td><td>${shortcuts[ key ]}</td></tr>`; } // Add custom key bindings that have associated descriptions for( let binding in bindings ) { if( bindings[binding].key && bindings[binding].description ) { html += `<tr><td>${bindings[binding].key}</td><td>${bindings[binding].description}</td></tr>`; } } html += '</table>'; dom.overlay.innerHTML = ` <header> <a class="close" href="#"><span class="icon"></span></a> </header> <div class="viewport"> <div class="viewport-inner">${html}</div> </div> `; dom.overlay.querySelector( '.close' ).addEventListener( 'click', event => { closeOverlay(); event.preventDefault(); }, false ); } } /** * Closes any currently open overlay. */ function closeOverlay() { if( dom.overlay ) { dom.overlay.parentNode.removeChild( dom.overlay ); dom.overlay = null; return true; } return false; } /** * Applies JavaScript-controlled layout rules to the * presentation. */ function layout() { if( dom.wrapper && !printView.isActive() ) { const viewportWidth = dom.viewport.offsetWidth; const viewportHeight = dom.viewport.offsetHeight; if( !config.disableLayout ) { // On some mobile devices '100vh' is taller than the visible // viewport which leads to part of the presentation being // cut off. To work around this we define our own '--vh' custom // property where 100x adds up to the correct height. // // https://css-tricks.com/the-trick-to-viewport-units-on-mobile/ if( Device.isMobile && !config.embedded ) { document.documentElement.style.setProperty( '--vh', ( window.innerHeight * 0.01 ) + 'px' ); } const size = scrollView.isActive() ? getComputedSlideSize( viewportWidth, viewportHeight ) : getComputedSlideSize(); const oldScale = scale; // Layout the contents of the slides layoutSlideContents( config.width, config.height ); dom.slides.style.width = size.width + 'px'; dom.slides.style.height = size.height + 'px'; // Determine scale of content to fit within available space scale = Math.min( size.presentationWidth / size.width, size.presentationHeight / size.height ); // Respect max/min scale settings scale = Math.max( scale, config.minScale ); scale = Math.min( scale, config.maxScale ); // Don't apply any scaling styles if scale is 1 or we're // in the scroll view if( scale === 1 || scrollView.isActive() ) { dom.slides.style.zoom = ''; dom.slides.style.left = ''; dom.slides.style.top = ''; dom.slides.style.bottom = ''; dom.slides.style.right = ''; transformSlides( { layout: '' } ); } else { dom.slides.style.zoom = ''; dom.slides.style.left = '50%'; dom.slides.style.top = '50%'; dom.slides.style.bottom = 'auto'; dom.slides.style.right = 'auto'; transformSlides( { layout: 'translate(-50%, -50%) scale('+ scale +')' } ); } // Select all slides, vertical and horizontal const slides = Array.from( dom.wrapper.querySelectorAll( SLIDES_SELECTOR ) ); for( let i = 0, len = slides.length; i < len; i++ ) { const slide = slides[ i ]; // Don't bother updating invisible slides if( slide.style.display === 'none' ) { continue; } if( ( config.center || slide.classList.contains( 'center' ) ) ) { // Vertical stacks are not centred since their section // children will be if( slide.classList.contains( 'stack' ) ) { slide.style.top = 0; } else { slide.style.top = Math.max( ( size.height - slide.scrollHeight ) / 2, 0 ) + 'px'; } } else { slide.style.top = ''; } } if( oldScale !== scale ) { dispatchEvent({ type: 'resize', data: { oldScale, scale, size } }); } } checkResponsiveScrollView(); dom.viewport.style.setProperty( '--slide-scale', scale ); dom.viewport.style.setProperty( '--viewport-width', viewportWidth + 'px' ); dom.viewport.style.setProperty( '--viewport-height', viewportHeight + 'px' ); scrollView.layout(); progress.update(); backgrounds.updateParallax(); if( overview.isActive() ) { overview.update(); } } } /** * Applies layout logic to the contents of all slides in * the presentation. * * @param {string|number} width * @param {string|number} height */ function layoutSlideContents( width, height ) { // Handle sizing of elements with the 'r-stretch' class Util.queryAll( dom.slides, 'section > .stretch, section > .r-stretch' ).forEach( element => { // Determine how much vertical space we can use let remainingHeight = Util.getRemainingHeight( element, height ); // Consider the aspect ratio of media elements if( /(img|video)/gi.test( element.nodeName ) ) { const nw = element.naturalWidth || element.videoWidth, nh = element.naturalHeight || element.videoHeight; const es = Math.min( width / nw, remainingHeight / nh ); element.style.width = ( nw * es ) + 'px'; element.style.height = ( nh * es ) + 'px'; } else { element.style.width = width + 'px'; element.style.height = remainingHeight + 'px'; } } ); } /** * Responsively activates the scroll mode when we reach the configured * activation width. */ function checkResponsiveScrollView() { // Only proceed if... // 1. The DOM is ready // 2. Layouts aren't disabled via config // 3. We're not currently printing // 4. There is a scrollActivationWidth set // 5. The deck isn't configured to always use the scroll view if( dom.wrapper && !config.disableLayout && !printView.isActive() && typeof config.scrollActivationWidth === 'number' && config.view !== 'scroll' ) { const size = getComputedSlideSize(); if( size.presentationWidth > 0 && size.presentationWidth <= config.scrollActivationWidth ) { if( !scrollView.isActive() ) { backgrounds.create(); scrollView.activate() }; } else { if( scrollView.isActive() ) scrollView.deactivate(); } } } /** * Calculates the computed pixel size of our slides. These * values are based on the width and height configuration * options. * * @param {number} [presentationWidth=dom.wrapper.offsetWidth] * @param {number} [presentationHeight=dom.wrapper.offsetHeight] */ function getComputedSlideSize( presentationWidth, presentationHeight ) { let width = config.width; let height = config.height; if( config.disableLayout ) { width = dom.slides.offsetWidth; height = dom.slides.offsetHeight; } const size = { // Slide size width: width, height: height, // Presentation size presentationWidth: presentationWidth || dom.wrapper.offsetWidth, presentationHeight: presentationHeight || dom.wrapper.offsetHeight }; // Reduce available space by margin size.presentationWidth -= ( size.presentationWidth * config.margin ); size.presentationHeight -= ( size.presentationHeight * config.margin ); // Slide width may be a percentage of available width if( typeof size.width === 'string' && /%$/.test( size.width ) ) { size.width = parseInt( size.width, 10 ) / 100 * size.presentationWidth; } // Slide height may be a percentage of available height if( typeof size.height === 'string' && /%$/.test( size.height ) ) { size.height = parseInt( size.height, 10 ) / 100 * size.presentationHeight; } return size; } /** * Stores the vertical index of a stack so that the same * vertical slide can be selected when navigating to and * from the stack. * * @param {HTMLElement} stack The vertical stack element * @param {string|number} [v=0] Index to memorize */ function setPreviousVerticalIndex( stack, v ) { if( typeof stack === 'object' && typeof stack.setAttribute === 'function' ) { stack.setAttribute( 'data-previous-indexv', v || 0 ); } } /** * Retrieves the vertical index which was stored using * #setPreviousVerticalIndex() or 0 if no previous index * exists. * * @param {HTMLElement} stack The vertical stack element */ function getPreviousVerticalIndex( stack ) { if( typeof stack === 'object' && typeof stack.setAttribute === 'function' && stack.classList.contains( 'stack' ) ) { // Prefer manually defined start-indexv const attributeName = stack.hasAttribute( 'data-start-indexv' ) ? 'data-start-indexv' : 'data-previous-indexv'; return parseInt( stack.getAttribute( attributeName ) || 0, 10 ); } return 0; } /** * Checks if the current or specified slide is vertical * (nested within another slide). * * @param {HTMLElement} [slide=currentSlide] The slide to check * orientation of * @return {Boolean} */ function isVerticalSlide( slide = currentSlide ) { return slide && slide.parentNode && !!slide.parentNode.nodeName.match( /section/i ); } /** * Checks if the current or specified slide is a stack containing * vertical slides. * * @param {HTMLElement} [slide=currentSlide] * @return {Boolean} */ function isVerticalStack( slide = currentSlide ) { return slide.classList.contains( '.stack' ) || slide.querySelector( 'section' ) !== null; } /** * Returns true if we're on the last slide in the current * vertical stack. */ function isLastVerticalSlide() { if( currentSlide && isVerticalSlide( currentSlide ) ) { // Does this slide have a next sibling? if( currentSlide.nextElementSibling ) return false; return true; } return false; } /** * Returns true if we're currently on the first slide in * the presentation. */ function isFirstSlide() { return indexh === 0 && indexv === 0; } /** * Returns true if we're currently on the last slide in * the presenation. If the last slide is a stack, we only * consider this the last slide if it's at the end of the * stack. */ function isLastSlide() { if( currentSlide ) { // Does this slide have a next sibling? if( currentSlide.nextElementSibling ) return false; // If it's vertical, does its parent have a next sibling? if( isVerticalSlide( currentSlide ) && currentSlide.parentNode.nextElementSibling ) return false; return true; } return false; } /** * Enters the paused mode which fades everything on screen to * black. */ function pause() { if( config.pause ) { const wasPaused = dom.wrapper.classList.contains( 'paused' ); cancelAutoSlide(); dom.wrapper.classList.add( 'paused' ); if( wasPaused === false ) { dispatchEvent({ type: 'paused' }); } } } /** * Exits from the paused mode. */ function resume() { const wasPaused = dom.wrapper.classList.contains( 'paused' ); dom.wrapper.classList.remove( 'paused' ); cueAutoSlide(); if( wasPaused ) { dispatchEvent({ type: 'resumed' }); } } /** * Toggles the paused mode on and off. */ function togglePause( override ) { if( typeof override === 'boolean' ) { override ? pause() : resume(); } else { isPaused() ? resume() : pause(); } } /** * Checks if we are currently in the paused mode. * * @return {Boolean} */ function isPaused() { return dom.wrapper.classList.contains( 'paused' ); } /** * Toggles visibility of the jump-to-slide UI. */ function toggleJumpToSlide( override ) { if( typeof override === 'boolean' ) { override ? jumpToSlide.show() : jumpToSlide.hide(); } else { jumpToSlide.isVisible() ? jumpToSlide.hide() : jumpToSlide.show(); } } /** * Toggles the auto slide mode on and off. * * @param {Boolean} [override] Flag which sets the desired state. * True means autoplay starts, false means it stops. */ function toggleAutoSlide( override ) { if( typeof override === 'boolean' ) { override ? resumeAutoSlide() : pauseAutoSlide(); } else { autoSlidePaused ? resumeAutoSlide() : pauseAutoSlide(); } } /** * Checks if the auto slide mode is currently on. * * @return {Boolean} */ function isAutoSliding() { return !!( autoSlide && !autoSlidePaused ); } /** * Steps from the current point in the presentation to the * slide which matches the specified horizontal and vertical * indices. * * @param {number} [h=indexh] Horizontal index of the target slide * @param {number} [v=indexv] Vertical index of the target slide * @param {number} [f] Index of a fragment within the * target slide to activate * @param {number} [origin] Origin for use in multimaster environments */ function slide( h, v, f, origin ) { // Dispatch an event before the slide const slidechange = dispatchEvent({ type: 'beforeslidechange', data: { indexh: h === undefined ? indexh : h, indexv: v === undefined ? indexv : v, origin } }); // Abort if this slide change was prevented by an event listener if( slidechange.defaultPrevented ) return; // Remember where we were at before previousSlide = currentSlide; // Query all horizontal slides in the deck const horizontalSlides = dom.wrapper.querySelectorAll( HORIZONTAL_SLIDES_SELECTOR ); // If we're in scroll mode, we scroll the target slide into view // instead of running our standard slide transition if( scrollView.isActive() ) { const scrollToSlide = scrollView.getSlideByIndices( h, v ); if( scrollToSlide ) scrollView.scrollToSlide( scrollToSlide ); return; } // Abort if there are no slides if( horizontalSlides.length === 0 ) return; // If no vertical index is specified and the upcoming slide is a // stack, resume at its previous vertical index if( v === undefined && !overview.isActive() ) { v = getPreviousVerticalIndex( horizontalSlides[ h ] ); } // If we were on a vertical stack, remember what vertical index // it was on so we can resume at the same position when returning if( previousSlide && previousSlide.parentNode && previousSlide.parentNode.classList.contains( 'stack' ) ) { setPreviousVerticalIndex( previousSlide.parentNode, indexv ); } // Remember the state before this slide const stateBefore = state.concat(); // Reset the state array state.length = 0; let indexhBefore = indexh || 0, indexvBefore = indexv || 0; // Activate and transition to the new slide indexh = updateSlides( HORIZONTAL_SLIDES_SELECTOR, h === undefined ? indexh : h ); indexv = updateSlides( VERTICAL_SLIDES_SELECTOR, v === undefined ? indexv : v ); // Dispatch an event if the slide changed let slideChanged = ( indexh !== indexhBefore || indexv !== indexvBefore ); // Ensure that the previous slide is never the same as the current if( !slideChanged ) previousSlide = null; // Find the current horizontal slide and any possible vertical slides // within it let currentHorizontalSlide = horizontalSlides[ indexh ], currentVerticalSlides = currentHorizontalSlide.querySelectorAll( 'section' ); // Store references to the previous and current slides currentSlide = currentVerticalSlides[ indexv ] || currentHorizontalSlide; let autoAnimateTransition = false; // Detect if we're moving between two auto-animated slides if( slideChanged && previousSlide && currentSlide && !overview.isActive() ) { transition = 'running'; autoAnimateTransition = shouldAutoAnimateBetween( previousSlide, currentSlide, indexhBefore, indexvBefore ); // If this is an auto-animated transition, we disable the // regular slide transition // // Note 20-03-2020: // This needs to happen before we update slide visibility, // otherwise transitions will still run in Safari. if( autoAnimateTransition ) { dom.slides.classList.add( 'disable-slide-transitions' ) } } // Update the visibility of slides now that the indices have changed updateSlidesVisibility(); layout(); // Update the overview if it's currently active if( overview.isActive() ) { overview.update(); } // Show fragment, if specified if( typeof f !== 'undefined' ) { fragments.goto( f ); } // Solves an edge case where the previous slide maintains the // 'present' class when navigating between adjacent vertical // stacks if( previousSlide && previousSlide !== currentSlide ) { previousSlide.classList.remove( 'present' ); previousSlide.setAttribute( 'aria-hidden', 'true' ); // Reset all slides upon navigate to home if( isFirstSlide() ) { // Launch async task setTimeout( () => { getVerticalStacks().forEach( slide => { setPreviousVerticalIndex( slide, 0 ); } ); }, 0 ); } } // Apply the new state stateLoop: for( let i = 0, len = state.length; i < len; i++ ) { // Check if this state existed on the previous slide. If it // did, we will avoid adding it repeatedly for( let j = 0; j < stateBefore.length; j++ ) { if( stateBefore[j] === state[i] ) { stateBefore.splice( j, 1 ); continue stateLoop; } } dom.viewport.classList.add( state[i] ); // Dispatch custom event matching the state's name dispatchEvent({ type: state[i] }); } // Clean up the remains of the previous state while( stateBefore.length ) { dom.viewport.classList.remove( stateBefore.pop() ); } if( slideChanged ) { dispatchSlideChanged( origin ); } // Handle embedded content if( slideChanged || !previousSlide ) { slideContent.stopEmbeddedContent( previousSlide ); slideContent.startEmbeddedContent( currentSlide ); } // Announce the current slide contents to screen readers // Use animation frame to prevent getComputedStyle in getStatusText // from triggering layout mid-frame requestAnimationFrame( () => { announceStatus( getStatusText( currentSlide ) ); }); progress.update(); controls.update(); notes.update(); backgrounds.update(); backgrounds.updateParallax(); slideNumber.update(); fragments.update(); // Update the URL hash location.writeURL(); cueAutoSlide(); // Auto-animation if( autoAnimateTransition ) { setTimeout( () => { dom.slides.classList.remove( 'disable-slide-transitions' ); }, 0 ); if( config.autoAnimate ) { // Run the auto-animation between our slides autoAnimate.run( previousSlide, currentSlide ); } } } /** * Checks whether or not an auto-animation should take place between * the two given slides. * * @param {HTMLElement} fromSlide * @param {HTMLElement} toSlide * @param {number} indexhBefore * @param {number} indexvBefore * * @returns {boolean} */ function shouldAutoAnimateBetween( fromSlide, toSlide, indexhBefore, indexvBefore ) { return fromSlide.hasAttribute( 'data-auto-animate' ) && toSlide.hasAttribute( 'data-auto-animate' ) && fromSlide.getAttribute( 'data-auto-animate-id' ) === toSlide.getAttribute( 'data-auto-animate-id' ) && !( ( indexh > indexhBefore || indexv > indexvBefore ) ? toSlide : fromSlide ).hasAttribute( 'data-auto-animate-restart' ); } /** * Called anytime a new slide should be activated while in the scroll * view. The active slide is the page that occupies the most space in * the scrollable viewport. * * @param {number} pageIndex * @param {HTMLElement} slideElement */ function setCurrentScrollPage( slideElement, h, v ) { let indexhBefore = indexh || 0; indexh = h; indexv = v; const slideChanged = currentSlide !== slideElement; previousSlide = currentSlide; currentSlide = slideElement; if( currentSlide && previousSlide ) { if( config.autoAnimate && shouldAutoAnimateBetween( previousSlide, currentSlide, indexhBefore, indexv ) ) { // Run the auto-animation between our slides autoAnimate.run( previousSlide, currentSlide ); } } // Start or stop embedded content like videos and iframes if( slideChanged ) { if( previousSlide ) { slideContent.stopEmbeddedContent( previousSlide ); slideContent.stopEmbeddedContent( previousSlide.slideBackgroundElement ); } slideContent.startEmbeddedContent( currentSlide ); slideContent.startEmbeddedContent( currentSlide.slideBackgroundElement ); } requestAnimationFrame( () => { announceStatus( getStatusText( currentSlide ) ); }); dispatchSlideChanged(); } /** * Syncs the presentation with the current DOM. Useful * when new slides or control elements are added or when * the configuration has changed. */ function sync() { // Subscribe to input removeEventListeners(); addEventListeners(); // Force a layout to make sure the current config is accounted for layout(); // Reflect the current autoSlide value autoSlide = config.autoSlide; // Start auto-sliding if it's enabled cueAutoSlide(); // Re-create all slide backgrounds backgrounds.create(); // Write the current hash to the URL location.writeURL(); if( config.sortFragmentsOnSync === true ) { fragments.sortAll(); } controls.update(); progress.update(); updateSlidesVisibility(); notes.update(); notes.updateVisibility(); backgrounds.update( true ); slideNumber.update(); slideContent.formatEmbeddedContent(); // Start or stop embedded content depending on global config if( config.autoPlayMedia === false ) { slideContent.stopEmbeddedContent( currentSlide, { unloadIframes: false } ); } else { slideContent.startEmbeddedContent( currentSlide ); } if( overview.isActive() ) { overview.layout(); } } /** * Updates reveal.js to keep in sync with new slide attributes. For * example, if you add a new `data-background-image` you can call * this to have reveal.js render the new background image. * * Similar to #sync() but more efficient when you only need to * refresh a specific slide. * * @param {HTMLElement} slide */ function syncSlide( slide = currentSlide ) { backgrounds.sync( slide ); fragments.sync( slide ); slideContent.load( slide ); backgrounds.update(); notes.update(); } /** * Resets all vertical slides so that only the first * is visible. */ function resetVerticalSlides() { getHorizontalSlides().forEach( horizontalSlide => { Util.queryAll( horizontalSlide, 'section' ).forEach( ( verticalSlide, y ) => { if( y > 0 ) { verticalSlide.classList.remove( 'present' ); verticalSlide.classList.remove( 'past' ); verticalSlide.classList.add( 'future' ); verticalSlide.setAttribute( 'aria-hidden', 'true' ); } } ); } ); } /** * Randomly shuffles all slides in the deck. */ function shuffle( slides = getHorizontalSlides() ) { slides.forEach( ( slide, i ) => { // Insert the slide next to a randomly picked sibling slide // slide. This may cause the slide to insert before itself, // but that's not an issue. let beforeSlide = slides[ Math.floor( Math.random() * slides.length ) ]; if( beforeSlide.parentNode === slide.parentNode ) { slide.parentNode.insertBefore( slide, beforeSlide ); } // Randomize the order of vertical slides (if there are any) let verticalSlides = slide.querySelectorAll( 'section' ); if( verticalSlides.length ) { shuffle( verticalSlides ); } } ); } /** * Updates one dimension of slides by showing the slide * with the specified index. * * @param {string} selector A CSS selector that will fetch * the group of slides we are working with * @param {number} index The index of the slide that should be * shown * * @return {number} The index of the slide that is now shown, * might differ from the passed in index if it was out of * bounds. */ function updateSlides( selector, index ) { // Select all slides and convert the NodeList result to // an array let slides = Util.queryAll( dom.wrapper, selector ), slidesLength = slides.length; let printMode = scrollView.isActive() || printView.isActive(); let loopedForwards = false; let loopedBackwards = false; if( slidesLength ) { // Should the index loop? if( config.loop ) { if( index >= slidesLength ) loopedForwards = true; index %= slidesLength; if( index < 0 ) { index = slidesLength + index; loopedBackwards = true; } } // Enforce max and minimum index bounds index = Math.max( Math.min( index, slidesLength - 1 ), 0 ); for( let i = 0; i < slidesLength; i++ ) { let element = slides[i]; let reverse = config.rtl && !isVerticalSlide( element ); // Avoid .remove() with multiple args for IE11 support element.classList.remove( 'past' ); element.classList.remove( 'present' ); element.classList.remove( 'future' ); // http://www.w3.org/html/wg/drafts/html/master/editing.html#the-hidden-attribute element.setAttribute( 'hidden', '' ); element.setAttribute( 'aria-hidden', 'true' ); // If this element contains vertical slides if( element.querySelector( 'section' ) ) { element.classList.add( 'stack' ); } // If we're printing static slides, all slides are "present" if( printMode ) { element.classList.add( 'present' ); continue; } if( i < index ) { // Any element previous to index is given the 'past' class element.classList.add( reverse ? 'future' : 'past' ); if( config.fragments ) { // Show all fragments in prior slides showFragmentsIn( element ); } } else if( i > index ) { // Any element subsequent to index is given the 'future' class element.classList.add( reverse ? 'past' : 'future' ); if( config.fragments ) { // Hide all fragments in future slides hideFragmentsIn( element ); } } // Update the visibility of fragments when a presentation loops // in eithe