tubestats-presentation/js/reveal.js

5683 lines
158 KiB
JavaScript
Raw Normal View History

import Plugins from './controllers/plugins.js'
2020-03-06 19:12:20 +00:00
import Playback from './components/playback.js'
2020-03-07 10:00:06 +00:00
import defaultConfig from './config.js'
import {
extend,
toArray,
distanceBetween,
deserialize,
transformElement,
injectStyleSheet,
closestParent,
colorToRgb,
colorBrightness,
enterFullscreen
} from './utils/util.js'
/**
2012-11-11 15:01:05 +00:00
* reveal.js
2017-11-22 13:46:55 +00:00
* http://revealjs.com
* MIT licensed
*
2020-01-15 10:39:19 +00:00
* Copyright (C) 2020 Hakim El Hattab, http://hakim.se
2011-06-07 19:10:59 +00:00
*/
export default function( revealElement, options ) {
2020-03-05 19:32:35 +00:00
let Reveal;
2014-04-09 00:08:21 +00:00
2016-01-08 09:26:41 +00:00
// The reveal.js version
2020-03-05 19:32:35 +00:00
const VERSION = '4.0.0-dev';
2016-01-08 09:26:41 +00:00
2020-03-05 19:32:35 +00:00
const SLIDES_SELECTOR = '.slides section';
const HORIZONTAL_SLIDES_SELECTOR = '.slides>section';
const VERTICAL_SLIDES_SELECTOR = '.slides>section.present>section';
const HOME_SLIDE_SELECTOR = '.slides>section:first-of-type';
2020-03-05 19:32:35 +00:00
const UA = navigator.userAgent;
2011-12-05 02:55:48 +00:00
2020-03-05 19:32:35 +00:00
// Methods that may not be invoked via the postMessage API
const POST_MESSAGE_METHOD_BLACKLIST = /registerPlugin|registerKeyboardShortcut|addKeyBinding|addEventListener/;
2020-03-05 19:32:35 +00:00
// Configuration defaults, can be overridden at initialization time
2020-03-07 10:00:06 +00:00
let config,
2011-12-22 04:22:49 +00:00
// Flags if reveal.js is loaded (has dispatched the 'ready' event)
ready = false,
// Flags if the overview mode is currently active
overview = false,
// Holds the dimensions of our overview slides, including margins
overviewSlideWidth = null,
overviewSlideHeight = null,
2013-03-01 16:13:46 +00:00
// The horizontal and vertical index of the currently active slide
2013-07-21 02:51:52 +00:00
indexh,
indexv,
// The previous and current slide HTML elements
previousSlide,
currentSlide,
previousBackground,
// Remember which directions that the user has navigated towards
2020-02-06 14:19:09 +00:00
hasNavigatedHorizontally = false,
hasNavigatedVertically = false,
// Slides may hold 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: '' },
2011-12-22 04:22:49 +00:00
// Cached references to DOM elements
dom = {},
// An instance of the Plugins controller
plugins = new Plugins(),
// List of asynchronously loaded reveal.js dependencies
asyncDependencies = [],
// Features supported by the browser, see #checkCapabilities()
features = {},
// Client is a mobile device, see #checkCapabilities()
isMobileDevice,
// Client is a desktop Chrome, see #checkCapabilities()
isChrome,
2012-01-15 03:22:27 +00:00
// Throttles mouse wheel navigation
2013-06-16 23:55:50 +00:00
lastMouseWheelStep = 0,
// Delays updates to the URL due to a Chrome thumbnailer bug
writeURLTimeout = 0,
// Is the mouse pointer currently hidden from view
cursorHidden = false,
// Timeout used to determine when the cursor is inactive
cursorInactiveTimeout = 0,
// Flags if the interaction event listeners are bound
eventsAreBound = false,
// <style> element used to apply auto-animations
autoAnimateStyleSheet,
2020-01-31 09:46:28 +00:00
// Counter used to generate unique IDs for auto-animated elements
autoAnimateCounter = 0,
// The current auto-slide duration
autoSlide = 0,
// Auto slide properties
2013-10-13 17:02:50 +00:00
autoSlidePlayer,
autoSlideTimeout = 0,
autoSlideStartTime = -1,
autoSlidePaused = false,
2013-10-13 17:02:50 +00:00
// Holds information about the currently ongoing touch input
touch = {
startX: 0,
startY: 0,
startCount: 0,
2013-08-10 18:09:23 +00:00
captured: false,
threshold: 40
},
2019-04-01 11:11:29 +00:00
// A key:value map of shortcut keyboard keys and descriptions of
// the actions they trigger, generated in #configure()
keyboardShortcuts = {},
2018-03-22 10:10:27 +00:00
// Holds custom key code mappings
registeredKeyBindings = {};
2011-06-07 19:10:59 +00:00
/**
* Starts up the presentation if the client is capable.
2011-06-07 19:10:59 +00:00
*/
function initialize() {
2016-06-10 08:41:16 +00:00
if( !revealElement ) {
console.warn( 'reveal.js must be instantiated with a valid .reveal element' );
return;
}
2016-06-10 08:41:16 +00:00
checkCapabilities();
// Cache references to key DOM elements
dom.wrapper = revealElement;
dom.slides = revealElement.querySelector( '.slides' );
// Force a layout when the whole page, incl fonts, has loaded
window.addEventListener( 'load', layout, false );
let query = Reveal.getQueryHash();
2013-10-24 12:59:52 +00:00
// Do not accept new dependencies via query config to avoid
// the potential of malicious script injection
if( typeof query['dependencies'] !== 'undefined' ) delete query['dependencies'];
// Copy options over to our config object
config = { ...defaultConfig, ...options, ...query };
// Load plugins and move on to #start() once done
plugins.load( config.dependencies ).then( start )
return Reveal;
}
/**
* Inspect the client to see what features it supports.
*/
function checkCapabilities() {
2019-10-11 07:23:44 +00:00
isMobileDevice = /(iphone|ipod|ipad|android)/gi.test( UA ) ||
( navigator.platform === 'MacIntel' && navigator.maxTouchPoints > 1 ); // iPadOS
isChrome = /chrome/i.test( UA ) && !/edge/i.test( UA );
2016-02-29 10:31:00 +00:00
2020-03-05 19:32:35 +00:00
let testElement = document.createElement( 'div' );
2016-02-29 10:31:00 +00:00
// Flags if we should use zoom instead of transform to scale
// up slides. Zoom produces crisper results but has a lot of
// xbrowser quirks so we only use it in whitelsited browsers.
features.zoom = 'zoom' in testElement.style && !isMobileDevice &&
( isChrome || /Version\/[\d\.]+.*Safari/.test( UA ) );
}
/**
* Starts up reveal.js by binding input events and navigating
* to the current URL deeplink if there is one.
*/
function start() {
ready = true;
// Make sure we've got all the DOM elements we need
setupDOM();
// Listen to messages posted to this window
setupPostMessage();
2016-04-07 07:07:19 +00:00
// Prevent the slides from being scrolled out of view
setupScrollPrevention();
// Resets all vertical slides so that only the first is visible
resetVerticalSlides();
// Updates the presentation to match the current configuration values
configure();
// Read the initial hash
readURL();
// Update all backgrounds
updateBackground( true );
// Notify listeners that the presentation is ready but use a 1ms
// timeout to ensure it's not fired synchronously after #initialize()
2020-03-06 13:54:55 +00:00
setTimeout( () => {
// Enable transitions now that we're loaded
dom.slides.classList.remove( 'no-transition' );
2016-07-01 06:44:27 +00:00
dom.wrapper.classList.add( 'ready' );
dispatchEvent( 'ready', {
'indexh': indexh,
'indexv': indexv,
'currentSlide': currentSlide
} );
}, 1 );
// Special setup and config is required when printing to PDF
if( isPrintingPDF() ) {
removeEventListeners();
// The document needs to have loaded for the PDF layout
// measurements to be accurate
if( document.readyState === 'complete' ) {
setupPDF();
}
else {
window.addEventListener( 'load', setupPDF );
}
}
}
/**
* 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' );
2017-05-18 12:11:48 +00:00
if( isMobileDevice ) {
dom.wrapper.classList.add( 'no-hover' );
}
else {
dom.wrapper.classList.remove( 'no-hover' );
}
if( /iphone/gi.test( UA ) ) {
dom.wrapper.classList.add( 'ua-iphone' );
}
else {
dom.wrapper.classList.remove( 'ua-iphone' );
}
// Background element
2013-08-11 14:34:04 +00:00
dom.background = createSingletonNode( dom.wrapper, 'div', 'backgrounds', null );
// Progress bar
2013-08-11 14:34:04 +00:00
dom.progress = createSingletonNode( dom.wrapper, 'div', 'progress', '<span></span>' );
dom.progressbar = dom.progress.querySelector( 'span' );
// Arrow controls
dom.controls = createSingletonNode( dom.wrapper, 'aside', 'controls',
2020-03-06 13:54:55 +00:00
`<button class="navigate-left" aria-label="${ config.rtl ? 'next slide' : 'previous slide' }"><div class="controls-arrow"></div></button>
<button class="navigate-right" aria-label="${ config.rtl ? 'previous slide' : 'next slide' }"><div class="controls-arrow"></div></button>
<button class="navigate-up" aria-label="above slide"><div class="controls-arrow"></div></button>
<button class="navigate-down" aria-label="below slide"><div class="controls-arrow"></div></button>` );
// Slide number
dom.slideNumber = createSingletonNode( dom.wrapper, 'div', 'slide-number', '' );
// Element containing notes that are visible to the audience
dom.speakerNotes = createSingletonNode( dom.wrapper, 'div', 'speaker-notes', null );
2015-09-10 09:26:05 +00:00
dom.speakerNotes.setAttribute( 'data-prevent-swipe', '' );
2016-05-23 08:50:39 +00:00
dom.speakerNotes.setAttribute( 'tabindex', '0' );
// Overlay graphic which is displayed during the paused mode
dom.pauseOverlay = createSingletonNode( dom.wrapper, 'div', 'pause-overlay', config.controls ? '<button class="resume-button">Resume presentation</button>' : null );
dom.wrapper.setAttribute( 'role', 'application' );
// There can be multiple instances of controls throughout the page
2020-03-07 13:12:28 +00:00
dom.controlsLeft = toArray( dom.wrapper.querySelectorAll( '.navigate-left' ) );
dom.controlsRight = toArray( dom.wrapper.querySelectorAll( '.navigate-right' ) );
dom.controlsUp = toArray( dom.wrapper.querySelectorAll( '.navigate-up' ) );
dom.controlsDown = toArray( dom.wrapper.querySelectorAll( '.navigate-down' ) );
dom.controlsPrev = toArray( dom.wrapper.querySelectorAll( '.navigate-prev' ) );
dom.controlsNext = toArray( dom.wrapper.querySelectorAll( '.navigate-next' ) );
// The left, right and down arrows in the standard reveal.js controls
dom.controlsRightArrow = dom.controls.querySelector( '.navigate-right' );
dom.controlsLeftArrow = dom.controls.querySelector( '.navigate-left' );
dom.controlsDownArrow = dom.controls.querySelector( '.navigate-down' );
dom.statusDiv = createStatusDiv();
}
/**
* 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.
2016-06-30 03:10:55 +00:00
*
* @return {HTMLElement}
*/
function createStatusDiv() {
2020-03-07 13:12:28 +00:00
let statusDiv = dom.wrapper.querySelector( '.aria-status' );
if( !statusDiv ) {
statusDiv = document.createElement( 'div' );
statusDiv.style.position = 'absolute';
statusDiv.style.height = '1px';
statusDiv.style.width = '1px';
2016-06-30 03:10:55 +00:00
statusDiv.style.overflow = 'hidden';
statusDiv.style.clip = 'rect( 1px, 1px, 1px, 1px )';
2020-03-07 13:12:28 +00:00
statusDiv.classList.add( 'aria-status' );
statusDiv.setAttribute( 'aria-live', 'polite' );
statusDiv.setAttribute( 'aria-atomic','true' );
dom.wrapper.appendChild( statusDiv );
}
return statusDiv;
}
2016-10-05 10:00:21 +00:00
/**
* 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 ) {
2020-03-06 13:54:55 +00:00
let text = '';
2016-10-05 10:00:21 +00:00
// Text node
if( node.nodeType === 3 ) {
2016-08-18 08:40:56 +00:00
text += node.textContent;
2016-10-05 10:00:21 +00:00
}
// Element node
else if( node.nodeType === 1 ) {
2020-03-06 13:54:55 +00:00
let isAriaHidden = node.getAttribute( 'aria-hidden' );
let isDisplayHidden = window.getComputedStyle( node )['display'] === 'none';
2016-10-05 10:00:21 +00:00
if( isAriaHidden !== 'true' && !isDisplayHidden ) {
2020-03-06 13:54:55 +00:00
toArray( node.childNodes ).forEach( child => {
2016-10-05 10:00:21 +00:00
text += getStatusText( child );
} );
2016-08-18 08:40:56 +00:00
}
2016-10-05 10:00:21 +00:00
2016-08-18 08:40:56 +00:00
}
2016-10-05 10:00:21 +00:00
2020-03-07 13:12:28 +00:00
text = text.trim();
return text === '' ? '' : text + ' ';
2016-10-05 10:00:21 +00:00
2016-08-18 08:40:56 +00:00
}
/**
* Configures the presentation for printing to a static
* PDF.
*/
function setupPDF() {
2020-03-07 10:58:18 +00:00
let slideSize = getComputedSlideSize( window.innerWidth, window.innerHeight );
2014-04-23 19:18:13 +00:00
// Dimensions of the PDF pages
2020-03-07 10:58:18 +00:00
let pageWidth = Math.floor( slideSize.width * ( 1 + config.margin ) ),
pageHeight = Math.floor( slideSize.height * ( 1 + config.margin ) );
2014-04-23 19:18:13 +00:00
// Dimensions of slides within the pages
2020-03-07 10:58:18 +00:00
let slideWidth = slideSize.width,
slideHeight = slideSize.height;
// Let the browser know what page size we want to print
injectStyleSheet( '@page{size:'+ pageWidth +'px '+ pageHeight +'px; margin: 0px;}' );
// Limit the size of certain elements to the dimensions of the slide
injectStyleSheet( '.reveal section>img, .reveal section>video, .reveal section>iframe{max-width: '+ slideWidth +'px; max-height:'+ slideHeight +'px}' );
document.body.classList.add( 'print-pdf' );
document.body.style.width = pageWidth + 'px';
document.body.style.height = pageHeight + 'px';
// Make sure stretch elements fit on slide
2017-04-07 07:55:55 +00:00
layoutSlideContents( slideWidth, slideHeight );
2019-03-02 17:21:29 +00:00
// Compute slide numbers now, before we start duplicating slides
2020-03-07 10:58:18 +00:00
let doingSlideNumbers = config.slideNumber && /all|print/i.test( config.showSlideNumber );
2019-03-02 17:21:29 +00:00
toArray( dom.wrapper.querySelectorAll( SLIDES_SELECTOR ) ).forEach( function( slide ) {
slide.setAttribute( 'data-slide-number', getSlideNumber( slide ) );
} );
// Slide and slide background layout
toArray( dom.wrapper.querySelectorAll( SLIDES_SELECTOR ) ).forEach( function( slide ) {
// Vertical stacks are not centred since their section
// children will be
2014-04-23 19:18:13 +00:00
if( slide.classList.contains( 'stack' ) === false ) {
// Center the slide inside of the page, giving the slide some margin
2020-03-07 10:58:18 +00:00
let left = ( pageWidth - slideWidth ) / 2,
2014-04-23 19:18:13 +00:00
top = ( pageHeight - slideHeight ) / 2;
2020-03-07 10:58:18 +00:00
let contentHeight = slide.scrollHeight;
let numberOfPages = Math.max( Math.ceil( contentHeight / pageHeight ), 1 );
// Adhere to configured pages per slide limit
numberOfPages = Math.min( numberOfPages, config.pdfMaxPagesPerSlide );
2014-04-26 08:22:18 +00:00
// Center slides vertically
if( numberOfPages === 1 && config.center || slide.classList.contains( 'center' ) ) {
top = Math.max( ( pageHeight - contentHeight ) / 2, 0 );
}
// Wrap the slide in a page element and hide its overflow
// so that no page ever flows onto another
2020-03-07 10:58:18 +00:00
let page = document.createElement( 'div' );
2016-04-28 15:07:26 +00:00
page.className = 'pdf-page';
page.style.height = ( ( pageHeight + config.pdfPageHeightOffset ) * numberOfPages ) + 'px';
slide.parentNode.insertBefore( page, slide );
page.appendChild( slide );
// Position the slide inside of the page
slide.style.left = left + 'px';
slide.style.top = top + 'px';
slide.style.width = slideWidth + 'px';
2016-04-28 15:07:26 +00:00
if( slide.slideBackgroundElement ) {
page.insertBefore( slide.slideBackgroundElement, slide );
}
// Inject notes if `showNotes` is enabled
if( config.showNotes ) {
// Are there notes for this slide?
2020-03-07 10:58:18 +00:00
let notes = getSlideNotes( slide );
if( notes ) {
2020-03-07 10:58:18 +00:00
let notesSpacing = 8;
let notesLayout = typeof config.showNotes === 'string' ? config.showNotes : 'inline';
let notesElement = document.createElement( 'div' );
notesElement.classList.add( 'speaker-notes' );
notesElement.classList.add( 'speaker-notes-pdf' );
notesElement.setAttribute( 'data-layout', notesLayout );
notesElement.innerHTML = notes;
if( notesLayout === 'separate-page' ) {
page.parentNode.insertBefore( notesElement, page.nextSibling );
}
else {
notesElement.style.left = notesSpacing + 'px';
notesElement.style.bottom = notesSpacing + 'px';
notesElement.style.width = ( pageWidth - notesSpacing*2 ) + 'px';
page.appendChild( notesElement );
}
}
}
// Inject slide numbers if `slideNumbers` are enabled
2019-03-02 17:21:29 +00:00
if( doingSlideNumbers ) {
2020-03-07 10:58:18 +00:00
let numberElement = document.createElement( 'div' );
numberElement.classList.add( 'slide-number' );
numberElement.classList.add( 'slide-number-pdf' );
2019-03-02 17:21:29 +00:00
numberElement.innerHTML = slide.getAttribute( 'data-slide-number' );
2016-04-28 15:07:26 +00:00
page.appendChild( numberElement );
}
// Copy page and show fragments one after another
2018-06-11 10:35:11 +00:00
if( config.pdfSeparateFragments ) {
// Each fragment 'group' is an array containing one or more
// fragments. Multiple fragments that appear at the same time
// are part of the same group.
2020-03-07 10:58:18 +00:00
let fragmentGroups = sortFragments( page.querySelectorAll( '.fragment' ), true );
2020-03-07 10:58:18 +00:00
let previousFragmentStep;
let previousPage;
2018-06-11 10:35:11 +00:00
fragmentGroups.forEach( function( fragments ) {
2018-06-11 10:35:11 +00:00
// Remove 'current-fragment' from the previous group
if( previousFragmentStep ) {
previousFragmentStep.forEach( function( fragment ) {
2018-06-11 10:35:11 +00:00
fragment.classList.remove( 'current-fragment' );
} );
}
2018-06-11 10:35:11 +00:00
// Show the fragments for the current index
fragments.forEach( function( fragment ) {
fragment.classList.add( 'visible', 'current-fragment' );
2017-08-08 20:53:32 +00:00
} );
// Create a separate page for the current fragment state
2020-03-07 10:58:18 +00:00
let clonedPage = page.cloneNode( true );
page.parentNode.insertBefore( clonedPage, ( previousPage || page ).nextSibling );
2018-06-11 10:35:11 +00:00
previousFragmentStep = fragments;
previousPage = clonedPage;
} );
// Reset the first/original page so that all fragments are hidden
fragmentGroups.forEach( function( fragments ) {
fragments.forEach( function( fragment ) {
fragment.classList.remove( 'visible', 'current-fragment' );
} );
} );
}
// Show all fragments
else {
2018-06-11 10:35:11 +00:00
toArray( page.querySelectorAll( '.fragment:not(.fade-out)' ) ).forEach( function( fragment ) {
fragment.classList.add( 'visible' );
} );
}
}
} );
// Notify subscribers that the PDF layout is good to go
dispatchEvent( 'pdf-ready' );
}
/**
2016-04-07 07:07:19 +00:00
* 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
2016-04-07 07:07:19 +00:00
* CSS (we already do) so we have to resort to repeatedly
* checking if the slides have been offset :(
*/
2016-04-07 07:07:19 +00:00
function setupScrollPrevention() {
2020-03-06 13:54:55 +00:00
setInterval( () => {
2016-04-07 07:07:19 +00:00
if( dom.wrapper.scrollTop !== 0 || dom.wrapper.scrollLeft !== 0 ) {
dom.wrapper.scrollTop = 0;
dom.wrapper.scrollLeft = 0;
}
}, 1000 );
}
2013-08-11 20:47:56 +00:00
/**
* Creates an HTML element and returns a reference to it.
* If the element already exists the existing instance will
* be returned.
2016-06-30 03:10:55 +00:00
*
* @param {HTMLElement} container
* @param {string} tagname
* @param {string} classname
* @param {string} innerHTML
*
* @return {HTMLElement}
2013-08-11 20:47:56 +00:00
*/
2020-03-06 13:54:55 +00:00
function createSingletonNode( container, tagname, classname, innerHTML='' ) {
2013-08-11 14:34:04 +00:00
// Find all nodes matching the description
2020-03-06 13:54:55 +00:00
let nodes = container.querySelectorAll( '.' + classname );
// Check all matches to find one which is a direct child of
// the specified container
2020-03-06 13:54:55 +00:00
for( let i = 0; i < nodes.length; i++ ) {
let testNode = nodes[i];
if( testNode.parentNode === container ) {
return testNode;
2013-08-11 14:30:08 +00:00
}
}
// If no node was found, create it now
2020-03-06 13:54:55 +00:00
let node = document.createElement( tagname );
node.className = classname;
2020-03-06 13:54:55 +00:00
node.innerHTML = innerHTML;
container.appendChild( node );
return node;
2013-08-11 14:34:04 +00:00
}
/**
* Creates the slide background elements and appends them
* to the background container. One element is created per
* slide no matter if the given slide has visible background.
*/
function createBackgrounds() {
2020-03-06 13:54:55 +00:00
let printMode = isPrintingPDF();
// Clear prior backgrounds
dom.background.innerHTML = '';
dom.background.classList.add( 'no-transition' );
// Iterate over all horizontal slides
2020-03-06 13:54:55 +00:00
toArray( dom.wrapper.querySelectorAll( HORIZONTAL_SLIDES_SELECTOR ) ).forEach( slideh => {
2020-03-06 13:54:55 +00:00
let backgroundStack = createBackground( slideh, dom.background );
// Iterate over all vertical slides
2020-03-06 13:54:55 +00:00
toArray( slideh.querySelectorAll( 'section' ) ).forEach( slidev => {
2016-04-28 15:07:26 +00:00
createBackground( slidev, backgroundStack );
2014-04-27 13:39:11 +00:00
backgroundStack.classList.add( 'stack' );
} );
} );
// Add parallax background if specified
if( config.parallaxBackgroundImage ) {
dom.background.style.backgroundImage = 'url("' + config.parallaxBackgroundImage + '")';
dom.background.style.backgroundSize = config.parallaxBackgroundSize;
dom.background.style.backgroundRepeat = config.parallaxBackgroundRepeat;
dom.background.style.backgroundPosition = config.parallaxBackgroundPosition;
2013-09-10 19:23:10 +00:00
// Make sure the below properties are set on the element - these properties are
// needed for proper transitions to be set on the element via CSS. To remove
// annoying background slide-in effect when the presentation starts, apply
// these properties after short time delay
2020-03-06 13:54:55 +00:00
setTimeout( () => {
dom.wrapper.classList.add( 'has-parallax-background' );
2013-09-10 19:23:10 +00:00
}, 1 );
2013-09-10 19:23:10 +00:00
}
else {
dom.background.style.backgroundImage = '';
dom.wrapper.classList.remove( 'has-parallax-background' );
}
}
/**
* Creates a background for the given slide.
*
* @param {HTMLElement} slide
* @param {HTMLElement} container The element that the background
* should be appended to
2016-06-30 03:10:55 +00:00
* @return {HTMLElement} New background div
*/
function createBackground( slide, container ) {
2018-05-03 13:25:54 +00:00
// Main slide background element
2020-03-06 13:54:55 +00:00
let element = document.createElement( 'div' );
2018-05-03 13:25:54 +00:00
element.className = 'slide-background ' + slide.className.replace( /present|past|future/, '' );
// Inner background element that wraps images/videos/iframes
2020-03-06 13:54:55 +00:00
let contentElement = document.createElement( 'div' );
2018-05-03 13:25:54 +00:00
contentElement.className = 'slide-background-content';
element.appendChild( contentElement );
container.appendChild( element );
slide.slideBackgroundElement = element;
slide.slideBackgroundContentElement = contentElement;
// Syncs the background to reflect all current background settings
syncBackground( slide );
return element;
}
/**
* Renders all of the visual properties of a slide background
* based on the various background attributes.
*
* @param {HTMLElement} slide
*/
function syncBackground( slide ) {
2020-03-06 13:54:55 +00:00
let element = slide.slideBackgroundElement,
2018-05-03 13:25:54 +00:00
contentElement = slide.slideBackgroundContentElement;
// Reset the prior background state in case this is not the
// initial sync
slide.classList.remove( 'has-dark-background' );
slide.classList.remove( 'has-light-background' );
element.removeAttribute( 'data-loaded' );
element.removeAttribute( 'data-background-hash' );
element.removeAttribute( 'data-background-size' );
element.removeAttribute( 'data-background-transition' );
element.style.backgroundColor = '';
contentElement.style.backgroundSize = '';
contentElement.style.backgroundRepeat = '';
contentElement.style.backgroundPosition = '';
contentElement.style.backgroundImage = '';
contentElement.style.opacity = '';
contentElement.innerHTML = '';
2020-03-06 13:54:55 +00:00
let data = {
background: slide.getAttribute( 'data-background' ),
backgroundSize: slide.getAttribute( 'data-background-size' ),
backgroundImage: slide.getAttribute( 'data-background-image' ),
2014-03-26 14:48:28 +00:00
backgroundVideo: slide.getAttribute( 'data-background-video' ),
2014-10-09 10:34:10 +00:00
backgroundIframe: slide.getAttribute( 'data-background-iframe' ),
backgroundColor: slide.getAttribute( 'data-background-color' ),
backgroundRepeat: slide.getAttribute( 'data-background-repeat' ),
backgroundPosition: slide.getAttribute( 'data-background-position' ),
backgroundTransition: slide.getAttribute( 'data-background-transition' ),
backgroundOpacity: slide.getAttribute( 'data-background-opacity' )
};
if( data.background ) {
// Auto-wrap image urls in url(...)
if( /^(http|file|\/\/)/gi.test( data.background ) || /\.(svg|png|jpg|jpeg|gif|bmp)([?#\s]|$)/gi.test( data.background ) ) {
slide.setAttribute( 'data-background-image', data.background );
}
else {
element.style.background = data.background;
}
}
2014-03-26 14:48:28 +00:00
// Create a hash for this combination of background settings.
// This is used to determine when two slide backgrounds are
// the same.
2014-10-09 10:34:10 +00:00
if( data.background || data.backgroundColor || data.backgroundImage || data.backgroundVideo || data.backgroundIframe ) {
2014-03-26 14:48:28 +00:00
element.setAttribute( 'data-background-hash', data.background +
data.backgroundSize +
data.backgroundImage +
data.backgroundVideo +
2014-10-09 10:34:10 +00:00
data.backgroundIframe +
2014-03-26 14:48:28 +00:00
data.backgroundColor +
data.backgroundRepeat +
data.backgroundPosition +
data.backgroundTransition +
data.backgroundOpacity );
}
// Additional and optional background properties
if( data.backgroundSize ) element.setAttribute( 'data-background-size', data.backgroundSize );
if( data.backgroundColor ) element.style.backgroundColor = data.backgroundColor;
if( data.backgroundTransition ) element.setAttribute( 'data-background-transition', data.backgroundTransition );
if( slide.hasAttribute( 'data-preload' ) ) element.setAttribute( 'data-preload', '' );
// Background image options are set on the content wrapper
if( data.backgroundSize ) contentElement.style.backgroundSize = data.backgroundSize;
if( data.backgroundRepeat ) contentElement.style.backgroundRepeat = data.backgroundRepeat;
if( data.backgroundPosition ) contentElement.style.backgroundPosition = data.backgroundPosition;
if( data.backgroundOpacity ) contentElement.style.opacity = data.backgroundOpacity;
// If this slide has a background color, we add a class that
2014-09-10 08:12:25 +00:00
// signals if it is light or dark. If the slide has no background
// color, no class will be added
2020-03-06 13:54:55 +00:00
let contrastColor = data.backgroundColor;
// If no bg color was found, check the computed background
if( !contrastColor ) {
2020-03-06 13:54:55 +00:00
let computedBackgroundStyle = window.getComputedStyle( element );
if( computedBackgroundStyle && computedBackgroundStyle.backgroundColor ) {
contrastColor = computedBackgroundStyle.backgroundColor;
}
}
if( contrastColor ) {
2020-03-06 13:54:55 +00:00
let rgb = colorToRgb( contrastColor );
// Ignore fully transparent backgrounds. Some browsers return
// rgba(0,0,0,0) when reading the computed background color of
// an element with no background
if( rgb && rgb.a !== 0 ) {
if( colorBrightness( contrastColor ) < 128 ) {
slide.classList.add( 'has-dark-background' );
}
else {
slide.classList.add( 'has-light-background' );
}
2014-09-10 08:12:25 +00:00
}
}
}
/**
* 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 ) {
2020-03-06 13:54:55 +00:00
window.addEventListener( 'message', event => {
const data = event.data;
// Make sure we're dealing with JSON
if( typeof data === 'string' && data.charAt( 0 ) === '{' && data.charAt( data.length - 1 ) === '}' ) {
data = JSON.parse( data );
// Check if the requested method can be found
if( data.method && typeof Reveal[data.method] === 'function' ) {
if( POST_MESSAGE_METHOD_BLACKLIST.test( data.method ) === false ) {
2020-03-07 10:58:18 +00:00
const result = Reveal[data.method].apply( Reveal, data.args );
// Dispatch a postMessage event with the returned value from
// our method invocation for getter functions
dispatchPostMessage( 'callback', { method: data.method, result: result } );
}
else {
console.warn( 'reveal.js: "'+ data.method +'" is is blacklisted from the postMessage API' );
}
}
}
}, false );
}
}
/**
2013-04-27 20:09:38 +00:00
* Applies the configuration settings from the config
* object. May be called multiple times.
2016-06-30 03:10:55 +00:00
*
* @param {object} options
*/
function configure( options ) {
2020-03-06 13:54:55 +00:00
const oldTransition = config.transition;
// New config options may be passed when this method
// is invoked through the API after initialization
if( typeof options === 'object' ) extend( config, options );
// Abort if reveal.js hasn't finished loading, config
// changes will be applied automatically once ready
if( Reveal.isReady() === false ) return;
2020-03-06 13:54:55 +00:00
const numberOfSlides = dom.wrapper.querySelectorAll( SLIDES_SELECTOR ).length;
// Remove the previously configured transition class
dom.wrapper.classList.remove( oldTransition );
dom.wrapper.classList.add( config.transition );
dom.wrapper.setAttribute( 'data-transition-speed', config.transitionSpeed );
dom.wrapper.setAttribute( 'data-background-transition', config.backgroundTransition );
dom.controls.style.display = config.controls ? 'block' : 'none';
dom.progress.style.display = config.progress ? 'block' : 'none';
2012-11-17 20:59:28 +00:00
dom.controls.setAttribute( 'data-controls-layout', config.controlsLayout );
dom.controls.setAttribute( 'data-controls-back-arrows', config.controlsBackArrows );
if( config.shuffle ) {
shuffle();
}
if( config.rtl ) {
dom.wrapper.classList.add( 'rtl' );
}
else {
dom.wrapper.classList.remove( 'rtl' );
}
if( config.center ) {
dom.wrapper.classList.add( 'center' );
}
else {
dom.wrapper.classList.remove( 'center' );
}
// Exit the paused mode if it was configured off
if( config.pause === false ) {
resume();
}
if( config.showNotes ) {
dom.speakerNotes.setAttribute( 'data-layout', typeof config.showNotes === 'string' ? config.showNotes : 'inline' );
}
2012-01-15 03:22:27 +00:00
if( config.mouseWheel ) {
document.addEventListener( 'DOMMouseScroll', onDocumentMouseScroll, false ); // FF
document.addEventListener( 'mousewheel', onDocumentMouseScroll, false );
2012-01-15 03:22:27 +00:00
}
else {
document.removeEventListener( 'DOMMouseScroll', onDocumentMouseScroll, false ); // FF
document.removeEventListener( 'mousewheel', onDocumentMouseScroll, false );
}
2012-01-15 03:22:27 +00:00
// Auto-hide the mouse pointer when its inactive
if( config.hideInactiveCursor ) {
document.addEventListener( 'mousemove', onDocumentCursorActive, false );
document.addEventListener( 'mousedown', onDocumentCursorActive, false );
}
else {
showCursor();
document.removeEventListener( 'mousemove', onDocumentCursorActive, false );
document.removeEventListener( 'mousedown', onDocumentCursorActive, false );
}
// Iframe link previews
if( config.previewLinks ) {
enablePreviewLinks();
disablePreviewLinks( '[data-preview-link=false]' );
}
else {
disablePreviewLinks();
enablePreviewLinks( '[data-preview-link]:not([data-preview-link=false])' );
}
2020-01-31 09:46:28 +00:00
// Reset all auto animated elements
2020-03-07 10:58:18 +00:00
toArray( dom.slides.querySelectorAll( '[data-auto-animate]:not([data-auto-animate=""])' ) ).forEach( element => {
element.dataset.autoAnimate = '';
} );
removeEphemeralAutoAnimateAttributes();
if( autoAnimateStyleSheet && autoAnimateStyleSheet.parentNode ) {
autoAnimateStyleSheet.parentNode.removeChild( autoAnimateStyleSheet );
autoAnimateStyleSheet = null;
}
2020-01-31 09:46:28 +00:00
// Remove existing auto-slide controls
if( autoSlidePlayer ) {
autoSlidePlayer.destroy();
autoSlidePlayer = null;
}
// Generate auto-slide controls if needed
if( numberOfSlides > 1 && config.autoSlide && config.autoSlideStoppable ) {
2020-03-06 13:54:55 +00:00
autoSlidePlayer = new Playback( dom.wrapper, () => {
return Math.min( Math.max( ( Date.now() - autoSlideStartTime ) / autoSlide, 0 ), 1 );
2013-10-13 17:02:50 +00:00
} );
autoSlidePlayer.on( 'click', onAutoSlidePlayerClick );
autoSlidePaused = false;
2013-10-13 17:02:50 +00:00
}
2014-03-25 13:28:22 +00:00
// When fragments are turned off they should be visible
if( config.fragments === false ) {
2020-03-06 13:54:55 +00:00
toArray( dom.slides.querySelectorAll( '.fragment' ) ).forEach( element => {
2014-03-25 13:28:22 +00:00
element.classList.add( 'visible' );
element.classList.remove( 'current-fragment' );
} );
}
2017-02-20 10:49:19 +00:00
// Slide numbers
2020-03-06 13:54:55 +00:00
let slideNumberDisplay = 'none';
2017-02-20 10:49:19 +00:00
if( config.slideNumber && !isPrintingPDF() ) {
if( config.showSlideNumber === 'all' ) {
slideNumberDisplay = 'block';
}
else if( config.showSlideNumber === 'speaker' && isSpeakerNotes() ) {
slideNumberDisplay = 'block';
}
}
dom.slideNumber.style.display = slideNumberDisplay;
// 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' );
}
2019-04-01 11:11:29 +00:00
// Define our contextual list of keyboard shortcuts
if( config.navigationMode === 'linear' ) {
2019-04-01 11:11:29 +00:00
keyboardShortcuts['&#8594; , &#8595; , SPACE , N , L , J'] = 'Next slide';
keyboardShortcuts['&#8592; , &#8593; , P , H , K'] = 'Previous slide';
}
else {
2019-04-01 11:11:29 +00:00
keyboardShortcuts['N , SPACE'] = 'Next slide';
keyboardShortcuts['P'] = 'Previous slide';
keyboardShortcuts['&#8592; , H'] = 'Navigate left';
keyboardShortcuts['&#8594; , L'] = 'Navigate right';
keyboardShortcuts['&#8593; , K'] = 'Navigate up';
keyboardShortcuts['&#8595; , J'] = 'Navigate down';
}
2019-04-01 11:11:29 +00:00
keyboardShortcuts['Home , Shift &#8592;'] = 'First slide';
keyboardShortcuts['End , Shift &#8594;'] = 'Last slide';
2019-04-01 11:11:29 +00:00
keyboardShortcuts['B , .'] = 'Pause';
keyboardShortcuts['F'] = 'Fullscreen';
keyboardShortcuts['ESC, O'] = 'Slide overview';
2013-04-27 20:09:38 +00:00
sync();
2013-03-04 20:59:44 +00:00
}
/**
* Binds all event listeners.
*/
function addEventListeners() {
eventsAreBound = true;
window.addEventListener( 'hashchange', onWindowHashChange, false );
window.addEventListener( 'resize', onWindowResize, false );
if( config.touch ) {
2018-03-22 10:55:44 +00:00
if( 'onpointerdown' in window ) {
// Use W3C pointer events
dom.wrapper.addEventListener( 'pointerdown', onPointerDown, false );
dom.wrapper.addEventListener( 'pointermove', onPointerMove, false );
dom.wrapper.addEventListener( 'pointerup', onPointerUp, false );
2013-12-02 22:23:51 +00:00
}
else if( window.navigator.msPointerEnabled ) {
// IE 10 uses prefixed version of pointer events
dom.wrapper.addEventListener( 'MSPointerDown', onPointerDown, false );
dom.wrapper.addEventListener( 'MSPointerMove', onPointerMove, false );
dom.wrapper.addEventListener( 'MSPointerUp', onPointerUp, false );
}
else {
// Fall back to touch events
dom.wrapper.addEventListener( 'touchstart', onTouchStart, false );
dom.wrapper.addEventListener( 'touchmove', onTouchMove, false );
dom.wrapper.addEventListener( 'touchend', onTouchEnd, false );
}
}
if( config.keyboard ) {
document.addEventListener( 'keydown', onDocumentKeyDown, false );
document.addEventListener( 'keypress', onDocumentKeyPress, false );
}
if( config.progress && dom.progress ) {
dom.progress.addEventListener( 'click', onProgressClicked, false );
}
dom.pauseOverlay.addEventListener( 'click', resume, false );
2014-06-05 08:59:30 +00:00
if( config.focusBodyOnPageVisibilityChange ) {
2020-03-02 13:52:50 +00:00
document.addEventListener( 'visibilitychange', onPageVisibilityChange, false );
}
// Listen to both touch and click events, in case the device
// supports both
2020-03-06 13:54:55 +00:00
let pointerEvents = [ 'touchstart', 'click' ];
// Only support touch for Android, fixes double navigations in
// stock browser
if( UA.match( /android/gi ) ) {
pointerEvents = [ 'touchstart' ];
}
2020-03-07 10:58:18 +00:00
pointerEvents.forEach( eventName => {
dom.controlsLeft.forEach( el => el.addEventListener( eventName, onNavigateLeftClicked, false ) );
dom.controlsRight.forEach( el => el.addEventListener( eventName, onNavigateRightClicked, false ) );
dom.controlsUp.forEach( el => el.addEventListener( eventName, onNavigateUpClicked, false ) );
dom.controlsDown.forEach( el => el.addEventListener( eventName, onNavigateDownClicked, false ) );
dom.controlsPrev.forEach( el => el.addEventListener( eventName, onNavigatePrevClicked, false ) );
dom.controlsNext.forEach( el => el.addEventListener( eventName, onNavigateNextClicked, false ) );
} );
}
/**
* Unbinds all event listeners.
*/
function removeEventListeners() {
eventsAreBound = false;
document.removeEventListener( 'keydown', onDocumentKeyDown, false );
document.removeEventListener( 'keypress', onDocumentKeyPress, false );
window.removeEventListener( 'hashchange', onWindowHashChange, false );
window.removeEventListener( 'resize', onWindowResize, false );
dom.wrapper.removeEventListener( 'pointerdown', onPointerDown, false );
dom.wrapper.removeEventListener( 'pointermove', onPointerMove, false );
dom.wrapper.removeEventListener( 'pointerup', onPointerUp, false );
dom.wrapper.removeEventListener( 'MSPointerDown', onPointerDown, false );
dom.wrapper.removeEventListener( 'MSPointerMove', onPointerMove, false );
dom.wrapper.removeEventListener( 'MSPointerUp', onPointerUp, false );
dom.wrapper.removeEventListener( 'touchstart', onTouchStart, false );
dom.wrapper.removeEventListener( 'touchmove', onTouchMove, false );
dom.wrapper.removeEventListener( 'touchend', onTouchEnd, false );
dom.pauseOverlay.removeEventListener( 'click', resume, false );
if ( config.progress && dom.progress ) {
dom.progress.removeEventListener( 'click', onProgressClicked, false );
}
2020-03-07 10:58:18 +00:00
[ 'touchstart', 'click' ].forEach( eventName => {
dom.controlsLeft.forEach( el => el.removeEventListener( eventName, onNavigateLeftClicked, false ) );
dom.controlsRight.forEach( el => el.removeEventListener( eventName, onNavigateRightClicked, false ) );
dom.controlsUp.forEach( el => el.removeEventListener( eventName, onNavigateUpClicked, false ) );
dom.controlsDown.forEach( el => el.removeEventListener( eventName, onNavigateDownClicked, false ) );
dom.controlsPrev.forEach( el => el.removeEventListener( eventName, onNavigatePrevClicked, false ) );
dom.controlsNext.forEach( el => el.removeEventListener( eventName, onNavigateNextClicked, false ) );
} );
2011-06-07 19:10:59 +00:00
}
/**
2017-11-29 08:46:45 +00:00
* Add a custom key binding with optional description to
* be added to the help screen.
*/
2017-11-29 08:46:45 +00:00
function addKeyBinding( binding, callback ) {
if( typeof binding === 'object' && binding.keyCode ) {
registeredKeyBindings[binding.keyCode] = {
callback: callback,
key: binding.key,
description: binding.description
};
}
else {
registeredKeyBindings[binding] = {
callback: callback,
key: null,
description: null
};
}
2017-11-29 08:46:45 +00:00
}
/**
2017-11-29 08:46:45 +00:00
* Removes the specified custom key binding.
*/
2017-11-29 08:46:45 +00:00
function removeKeyBinding( keyCode ) {
delete registeredKeyBindings[keyCode];
}
/**
* Applies CSS transforms to the slides container. The container
* is transformed from two separate sources: layout and the overview
* mode.
2016-06-30 03:10:55 +00:00
*
* @param {object} transforms
*/
function transformSlides( transforms ) {
// Pick up new transforms from arguments
2015-01-29 11:21:05 +00:00
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 ) {
transformElement( dom.slides, slidesTransform.layout + ' ' + slidesTransform.overview );
}
else {
transformElement( dom.slides, slidesTransform.overview );
}
}
/**
* Returns the remaining height within the parent of the
* target element.
*
* remaining height = [ configured parent height ] - [ current parent height ]
2017-03-18 02:47:25 +00:00
*
2016-06-30 03:10:55 +00:00
* @param {HTMLElement} element
* @param {number} [height]
*/
2020-03-06 13:54:55 +00:00
function getRemainingHeight( element, height = 0 ) {
if( element ) {
2020-03-06 13:54:55 +00:00
let newHeight, oldHeight = element.style.height;
// Change the .stretch element height to 0 in order find the height of all
// the other elements
element.style.height = '0px';
2019-01-07 13:43:46 +00:00
// In Overview mode, the parent (.slide) height is set of 700px.
// Restore it temporarily to its natural height.
element.parentNode.style.height = 'auto';
2019-01-07 13:43:46 +00:00
newHeight = height - element.parentNode.offsetHeight;
// Restore the old height, just in case
element.style.height = oldHeight + 'px';
// Clear the parent (.slide) height. .removeProperty works in IE9+
element.parentNode.style.removeProperty('height');
return newHeight;
}
return height;
}
/**
* Checks if this instance is being used to print a PDF.
*/
function isPrintingPDF() {
return ( /print-pdf/gi ).test( window.location.search );
}
/**
* Dispatches an event of the specified type from the
* reveal DOM element.
*/
function dispatchEvent( type, args ) {
2020-03-06 13:54:55 +00:00
let event = document.createEvent( 'HTMLEvents', 1, 2 );
event.initEvent( type, true, true );
extend( event, args );
dom.wrapper.dispatchEvent( event );
// If we're in an iframe, post each reveal.js event to the
// parent window. Used by the notes plugin
dispatchPostMessage( type );
}
/**
* Dispatched a postMessage of the given type from our window.
*/
function dispatchPostMessage( type, data ) {
if( config.postMessageEvents && window.parent !== window.self ) {
2020-03-06 13:54:55 +00:00
let message = {
namespace: 'reveal',
eventName: type,
state: getState()
};
extend( message, data );
window.parent.postMessage( JSON.stringify( message ), '*' );
}
}
/**
* Bind preview frame links.
2016-06-30 03:10:55 +00:00
*
* @param {string} [selector=a] - selector for anchors
*/
2020-03-06 13:54:55 +00:00
function enablePreviewLinks( selector = 'a' ) {
2020-03-07 13:12:28 +00:00
toArray( dom.wrapper.querySelectorAll( selector ) ).forEach( element => {
if( /^(http|www)/gi.test( element.getAttribute( 'href' ) ) ) {
element.addEventListener( 'click', onPreviewLinkClicked, false );
}
} );
}
/**
* Unbind preview frame links.
*/
2020-03-06 13:54:55 +00:00
function disablePreviewLinks( selector = 'a' ) {
2020-03-07 13:12:28 +00:00
toArray( 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.
2016-06-30 03:10:55 +00:00
*
* @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 );
2020-03-05 19:32:35 +00:00
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>`;
2020-03-06 13:54:55 +00:00
dom.overlay.querySelector( 'iframe' ).addEventListener( 'load', event => {
dom.overlay.classList.add( 'loaded' );
}, false );
2020-03-06 13:54:55 +00:00
dom.overlay.querySelector( '.close' ).addEventListener( 'click', event => {
closeOverlay();
event.preventDefault();
}, false );
2020-03-06 13:54:55 +00:00
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 ){
2017-02-09 10:37:47 +00:00
if( typeof override === 'boolean' ) {
2017-02-09 10:37:47 +00:00
override ? showHelp() : closeOverlay();
}
2017-02-09 10:37:47 +00:00
else {
if( dom.overlay ) {
closeOverlay();
}
else {
2017-02-09 10:37:47 +00:00
showHelp();
}
}
}
/**
2016-06-30 03:10:55 +00:00
* 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 );
2020-03-06 13:54:55 +00:00
let html = '<p class="title">Keyboard Shortcuts</p><br/>';
html += '<table><th>KEY</th><th>ACTION</th>';
2020-03-07 10:58:18 +00:00
for( let key in keyboardShortcuts ) {
2020-03-05 19:32:35 +00:00
html += `<tr><td>${key}</td><td>${keyboardShortcuts[ key ]}</td></tr>`;
}
2017-11-29 08:46:45 +00:00
// Add custom key bindings that have associated descriptions
2020-03-07 10:58:18 +00:00
for( let binding in registeredKeyBindings ) {
2017-11-29 08:46:45 +00:00
if( registeredKeyBindings[binding].key && registeredKeyBindings[binding].description ) {
2020-03-05 19:32:35 +00:00
html += `<tr><td>${registeredKeyBindings[binding].key}</td><td>${registeredKeyBindings[binding].description}</td></tr>`;
}
}
html += '</table>';
2020-03-05 19:32:35 +00:00
dom.overlay.innerHTML = `
<header>
<a class="close" href="#"><span class="icon"></span></a>
</header>
<div class="viewport">
<div class="viewport-inner">${html}</div>
</div>
`;
2020-03-07 10:58:18 +00:00
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;
}
}
/**
* Applies JavaScript-controlled layout rules to the
* presentation.
*/
function layout() {
if( dom.wrapper && !isPrintingPDF() ) {
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( isMobileDevice ) {
document.documentElement.style.setProperty( '--vh', ( window.innerHeight * 0.01 ) + 'px' );
}
2020-03-06 13:54:55 +00:00
const size = getComputedSlideSize();
2020-03-06 13:54:55 +00:00
const oldScale = scale;
2019-01-31 19:13:32 +00:00
// 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
if( scale === 1 ) {
dom.slides.style.zoom = '';
dom.slides.style.left = '';
dom.slides.style.top = '';
dom.slides.style.bottom = '';
dom.slides.style.right = '';
transformSlides( { layout: '' } );
}
else {
// Zoom Scaling
// Content remains crisp no matter how much we scale. Side
// effects are minor differences in text layout and iframe
// viewports changing size. A 200x200 iframe viewport in a
// 2x zoomed presentation ends up having a 400x400 viewport.
if( scale > 1 && features.zoom && window.devicePixelRatio < 2 ) {
dom.slides.style.zoom = scale;
dom.slides.style.left = '';
dom.slides.style.top = '';
dom.slides.style.bottom = '';
dom.slides.style.right = '';
transformSlides( { layout: '' } );
}
// Transform Scaling
// Content layout remains the exact same when scaled up.
// Side effect is content becoming blurred, especially with
// high scale values on ldpi screens.
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
2020-03-06 13:54:55 +00:00
const slides = toArray( dom.wrapper.querySelectorAll( SLIDES_SELECTOR ) );
2020-03-07 10:58:18 +00:00
for( let i = 0, len = slides.length; i < len; i++ ) {
2020-03-06 13:54:55 +00:00
const slide = slides[ i ];
// Don't bother updating invisible slides
if( slide.style.display === 'none' ) {
continue;
}
2020-03-06 13:54:55 +00:00
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 = '';
}
}
2019-01-31 19:13:32 +00:00
if( oldScale !== scale ) {
2019-01-15 12:13:19 +00:00
dispatchEvent( 'resize', {
2019-01-31 19:13:32 +00:00
'oldScale': oldScale,
2019-01-15 12:13:19 +00:00
'scale': scale,
'size': size
} );
}
}
2013-04-27 20:10:47 +00:00
updateProgress();
updateParallax();
2013-04-27 20:10:47 +00:00
if( isOverview() ) {
updateOverview();
}
}
}
2013-08-18 21:53:41 +00:00
/**
* Applies layout logic to the contents of all slides in
* the presentation.
2016-06-30 03:10:55 +00:00
*
* @param {string|number} width
* @param {string|number} height
2013-08-18 21:53:41 +00:00
*/
function layoutSlideContents( width, height ) {
2013-08-18 21:53:41 +00:00
// Handle sizing of elements with the 'stretch' class
2020-03-06 13:54:55 +00:00
toArray( dom.slides.querySelectorAll( 'section > .stretch' ) ).forEach( element => {
2013-08-18 21:53:41 +00:00
// Determine how much vertical space we can use
2020-03-07 10:58:18 +00:00
let remainingHeight = getRemainingHeight( element, height );
2013-08-18 21:53:41 +00:00
// Consider the aspect ratio of media elements
if( /(img|video)/gi.test( element.nodeName ) ) {
2020-03-06 13:54:55 +00:00
const nw = element.naturalWidth || element.videoWidth,
nh = element.naturalHeight || element.videoHeight;
2013-08-18 21:53:41 +00:00
2020-03-06 13:54:55 +00:00
const es = Math.min( width / nw, remainingHeight / nh );
2013-08-18 21:53:41 +00:00
element.style.width = ( nw * es ) + 'px';
element.style.height = ( nh * es ) + 'px';
}
else {
element.style.width = width + 'px';
element.style.height = remainingHeight + 'px';
}
} );
}
/**
* Calculates the computed pixel size of our slides. These
* values are based on the width and height configuration
* options.
2016-06-30 03:10:55 +00:00
*
* @param {number} [presentationWidth=dom.wrapper.offsetWidth]
* @param {number} [presentationHeight=dom.wrapper.offsetHeight]
*/
function getComputedSlideSize( presentationWidth, presentationHeight ) {
2020-03-06 13:54:55 +00:00
const size = {
// Slide size
width: config.width,
height: config.height,
// Presentation size
presentationWidth: presentationWidth || dom.wrapper.offsetWidth,
presentationHeight: presentationHeight || dom.wrapper.offsetHeight
};
// Reduce available space by margin
2015-03-19 03:49:19 +00:00
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
2016-06-30 03:10:55 +00:00
* @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' ) ) {
2013-05-05 22:40:08 +00:00
// Prefer manually defined start-indexv
2020-03-06 13:54:55 +00:00
const attributeName = stack.hasAttribute( 'data-start-indexv' ) ? 'data-start-indexv' : 'data-previous-indexv';
2013-05-05 22:40:08 +00:00
return parseInt( stack.getAttribute( attributeName ) || 0, 10 );
}
return 0;
}
/**
2015-01-29 11:03:02 +00:00
* Displays the overview of slides (quick nav) by scaling
* down and arranging all slide elements.
*/
function activateOverview() {
// Only proceed if enabled in config
if( config.overview && !isOverview() ) {
overview = true;
2013-08-10 17:32:19 +00:00
dom.wrapper.classList.add( 'overview' );
// Don't auto-slide while in overview mode
cancelAutoSlide();
// Move the backgrounds element into the slide container to
// that the same scaling is applied
dom.slides.appendChild( dom.background );
// Clicking on an overview slide navigates to it
2020-03-06 13:54:55 +00:00
toArray( dom.wrapper.querySelectorAll( SLIDES_SELECTOR ) ).forEach( slide => {
if( !slide.classList.contains( 'stack' ) ) {
slide.addEventListener( 'click', onOverviewSlideClicked, true );
}
2015-01-27 08:21:49 +00:00
} );
// Calculate slide sizes
2020-03-06 13:54:55 +00:00
const margin = 70;
const slideSize = getComputedSlideSize();
overviewSlideWidth = slideSize.width + margin;
overviewSlideHeight = slideSize.height + margin;
// Reverse in RTL mode
if( config.rtl ) {
overviewSlideWidth = -overviewSlideWidth;
}
updateSlidesVisibility();
2015-01-27 08:21:49 +00:00
layoutOverview();
updateOverview();
layout();
// Notify observers of the overview showing
dispatchEvent( 'overviewshown', {
'indexh': indexh,
'indexv': indexv,
'currentSlide': currentSlide
} );
}
}
2015-01-27 08:21:49 +00:00
/**
2015-01-29 11:03:02 +00:00
* Uses CSS transforms to position all slides in a grid for
* display inside of the overview mode.
2015-01-27 08:21:49 +00:00
*/
function layoutOverview() {
// Layout slides
2020-03-06 13:54:55 +00:00
toArray( dom.wrapper.querySelectorAll( HORIZONTAL_SLIDES_SELECTOR ) ).forEach( ( hslide, h ) => {
hslide.setAttribute( 'data-index-h', h );
transformElement( hslide, 'translate3d(' + ( h * overviewSlideWidth ) + 'px, 0, 0)' );
2015-01-27 08:21:49 +00:00
if( hslide.classList.contains( 'stack' ) ) {
2020-03-06 13:54:55 +00:00
toArray( hslide.querySelectorAll( 'section' ) ).forEach( ( vslide, v ) => {
vslide.setAttribute( 'data-index-h', h );
vslide.setAttribute( 'data-index-v', v );
transformElement( vslide, 'translate3d(0, ' + ( v * overviewSlideHeight ) + 'px, 0)' );
2015-01-27 08:21:49 +00:00
} );
}
} );
// Layout slide backgrounds
2020-03-06 13:54:55 +00:00
toArray( dom.background.childNodes ).forEach( ( hbackground, h ) => {
transformElement( hbackground, 'translate3d(' + ( h * overviewSlideWidth ) + 'px, 0, 0)' );
2015-01-27 08:21:49 +00:00
2020-03-06 13:54:55 +00:00
toArray( hbackground.querySelectorAll( '.slide-background' ) ).forEach( ( vbackground, v ) => {
transformElement( vbackground, 'translate3d(0, ' + ( v * overviewSlideHeight ) + 'px, 0)' );
2015-01-27 08:21:49 +00:00
} );
} );
}
/**
* Moves the overview viewport to the current slides.
* Called each time the current slide changes.
*/
function updateOverview() {
2020-03-05 19:32:35 +00:00
const vmin = Math.min( window.innerWidth, window.innerHeight );
const scale = Math.max( vmin / 5, 150 ) / vmin;
transformSlides( {
overview: [
'scale('+ scale +')',
'translateX('+ ( -indexh * overviewSlideWidth ) +'px)',
'translateY('+ ( -indexv * overviewSlideHeight ) +'px)'
].join( ' ' )
} );
}
/**
* Exits the slide overview and enters the currently
* active slide.
*/
function deactivateOverview() {
// Only proceed if enabled in config
if( config.overview ) {
overview = false;
dom.wrapper.classList.remove( 'overview' );
2013-01-16 20:49:10 +00:00
// Temporarily add a class so that transitions can do different things
// depending on whether they are exiting/entering overview, or just
// moving from slide to slide
2013-08-26 13:20:12 +00:00
dom.wrapper.classList.add( 'overview-deactivating' );
2013-01-18 20:31:41 +00:00
2020-03-06 13:54:55 +00:00
setTimeout( () => {
2013-08-26 13:20:12 +00:00
dom.wrapper.classList.remove( 'overview-deactivating' );
}, 1 );
2015-01-27 08:21:49 +00:00
// Move the background element back out
dom.wrapper.appendChild( dom.background );
// Clean up changes made to slides
2020-03-06 13:54:55 +00:00
toArray( dom.wrapper.querySelectorAll( SLIDES_SELECTOR ) ).forEach( slide => {
2013-08-26 13:20:12 +00:00
transformElement( slide, '' );
2013-08-26 13:20:12 +00:00
slide.removeEventListener( 'click', onOverviewSlideClicked, true );
} );
// Clean up changes made to backgrounds
2020-03-06 13:54:55 +00:00
toArray( dom.background.querySelectorAll( '.slide-background' ) ).forEach( background => {
transformElement( background, '' );
} );
2015-01-29 11:21:05 +00:00
transformSlides( { overview: '' } );
slide( indexh, indexv );
layout();
cueAutoSlide();
// Notify observers of the overview hiding
dispatchEvent( 'overviewhidden', {
'indexh': indexh,
'indexv': indexv,
'currentSlide': currentSlide
} );
}
}
/**
* Toggles the slide overview mode on and off.
*
2016-06-30 03:10:55 +00:00
* @param {Boolean} [override] Flag which overrides the
* toggle logic and forcibly sets the desired state. True means
* overview is open, false means it's closed.
*/
function toggleOverview( override ) {
if( typeof override === 'boolean' ) {
override ? activateOverview() : deactivateOverview();
}
else {
isOverview() ? deactivateOverview() : activateOverview();
}
}
/**
* Checks if the overview is currently active.
*
* @return {Boolean} true if the overview is active,
* false otherwise
*/
function isOverview() {
return overview;
}
/**
* Return a hash URL that will resolve to the given slide location.
*
* @param {HTMLElement} [slide=currentSlide] The slide to link to
*/
function locationHash( slide ) {
2020-03-06 13:54:55 +00:00
let url = '/';
// Attempt to create a named link based on the slide's ID
2020-03-06 13:54:55 +00:00
let s = slide || currentSlide;
let id = s ? s.getAttribute( 'id' ) : null;
if( id ) {
id = encodeURIComponent( id );
}
2020-03-06 13:54:55 +00:00
let index = getIndices( slide );
if( !config.fragmentInURL ) {
index.f = undefined;
}
// If the current slide has an ID, use that as a named link,
// but we don't support named links with a fragment index
if( typeof id === 'string' && id.length && index.f === undefined ) {
url = '/' + id;
}
// Otherwise use the /h/v index
else {
2020-03-06 13:54:55 +00:00
let hashIndexBase = config.hashOneBasedIndex ? 1 : 0;
if( index.h > 0 || index.v > 0 || index.f !== undefined ) url += index.h + hashIndexBase;
if( index.v > 0 || index.f !== undefined ) url += '/' + (index.v + hashIndexBase );
if( index.f !== undefined ) url += '/' + index.f;
}
return url;
}
2013-04-30 02:07:09 +00:00
/**
* Checks if the current or specified slide is vertical
* (nested within another slide).
*
2016-06-30 03:10:55 +00:00
* @param {HTMLElement} [slide=currentSlide] The slide to check
2013-04-30 02:07:09 +00:00
* orientation of
2016-06-30 03:10:55 +00:00
* @return {Boolean}
2013-04-30 02:07:09 +00:00
*/
2020-03-06 13:54:55 +00:00
function isVerticalSlide( slide = currentSlide ) {
2013-04-30 02:07:09 +00:00
return slide && slide.parentNode && !!slide.parentNode.nodeName.match( /section/i );
2013-04-30 02:07:09 +00:00
}
/**
* Shows the mouse pointer after it has been hidden with
* #hideCursor.
*/
function showCursor() {
if( cursorHidden ) {
cursorHidden = false;
dom.wrapper.style.cursor = '';
}
}
/**
* Hides the mouse pointer when it's on top of the .reveal
* container.
*/
function hideCursor() {
if( cursorHidden === false ) {
cursorHidden = true;
dom.wrapper.style.cursor = 'none';
}
}
/**
* Enters the paused mode which fades everything on screen to
* black.
*/
function pause() {
if( config.pause ) {
2020-03-06 13:54:55 +00:00
const wasPaused = dom.wrapper.classList.contains( 'paused' );
cancelAutoSlide();
dom.wrapper.classList.add( 'paused' );
if( wasPaused === false ) {
dispatchEvent( 'paused' );
}
}
}
/**
* Exits from the paused mode.
*/
function resume() {
2020-03-06 13:54:55 +00:00
const wasPaused = dom.wrapper.classList.contains( 'paused' );
dom.wrapper.classList.remove( 'paused' );
cueAutoSlide();
if( wasPaused ) {
dispatchEvent( '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.
2016-06-30 03:10:55 +00:00
*
* @return {Boolean}
*/
function isPaused() {
return dom.wrapper.classList.contains( 'paused' );
}
/**
* Toggles the auto slide mode on and off.
*
2016-06-30 03:10:55 +00:00
* @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.
2016-06-30 03:10:55 +00:00
*
* @return {Boolean}
*/
2013-12-21 16:27:33 +00:00
function isAutoSliding() {
return !!( autoSlide && !autoSlidePaused );
}
2011-06-07 19:10:59 +00:00
/**
* Steps from the current point in the presentation to the
* slide which matches the specified horizontal and vertical
* indices.
*
2016-06-30 03:10:55 +00:00
* @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
2016-06-30 03:10:55 +00:00
* @param {number} [o] Origin for use in multimaster environments
2011-06-07 19:10:59 +00:00
*/
2013-03-08 00:51:58 +00:00
function slide( h, v, f, o ) {
// Remember where we were at before
previousSlide = currentSlide;
// Query all horizontal slides in the deck
2020-03-06 13:54:55 +00:00
const horizontalSlides = dom.wrapper.querySelectorAll( HORIZONTAL_SLIDES_SELECTOR );
// 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 && !isOverview() ) {
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 );
}
2012-03-31 03:51:37 +00:00
// Remember the state before this slide
2020-03-06 13:54:55 +00:00
const stateBefore = state.concat();
2012-03-31 03:51:37 +00:00
// Reset the state array
state.length = 0;
2020-03-06 13:54:55 +00:00
let indexhBefore = indexh || 0,
indexvBefore = indexv || 0;
2012-03-31 03:51:37 +00:00
// 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 );
// Update the visibility of slides now that the indices have changed
updateSlidesVisibility();
layout();
2015-01-29 11:21:05 +00:00
// Update the overview if it's currently active
if( isOverview() ) {
updateOverview();
}
// Find the current horizontal slide and any possible vertical slides
// within it
2020-03-06 13:54:55 +00:00
let currentHorizontalSlide = horizontalSlides[ indexh ],
currentVerticalSlides = currentHorizontalSlide.querySelectorAll( 'section' );
// Store references to the previous and current slides
currentSlide = currentVerticalSlides[ indexv ] || currentHorizontalSlide;
// Show fragment, if specified
if( typeof f !== 'undefined' ) {
navigateFragment( f );
}
// Dispatch an event if the slide changed
2020-03-06 13:54:55 +00:00
let slideChanged = ( indexh !== indexhBefore || indexv !== indexvBefore );
if (!slideChanged) {
// Ensure that the previous slide is never the same as the current
previousSlide = null;
}
// 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' );
2013-01-11 21:43:43 +00:00
// Reset all slides upon navigate to home
2020-03-06 13:54:55 +00:00
if( Reveal.isFirstSlide() ) {
// Launch async task
2020-03-06 13:54:55 +00:00
setTimeout( () => {
getVerticalStacks().forEach( slide => {
setPreviousVerticalIndex( slide, 0 );
} );
}, 0 );
}
}
// Apply the new state
2020-03-06 13:54:55 +00:00
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
2020-03-06 13:54:55 +00:00
for( let j = 0; j < stateBefore.length; j++ ) {
if( stateBefore[j] === state[i] ) {
stateBefore.splice( j, 1 );
continue stateLoop;
}
}
document.documentElement.classList.add( state[i] );
// Dispatch custom event matching the state's name
dispatchEvent( state[i] );
}
// Clean up the remains of the previous state
while( stateBefore.length ) {
document.documentElement.classList.remove( stateBefore.pop() );
}
if( slideChanged ) {
dispatchEvent( 'slidechanged', {
'indexh': indexh,
'indexv': indexv,
'previousSlide': previousSlide,
'currentSlide': currentSlide,
'origin': o
} );
}
// Handle embedded content
2014-05-20 06:53:25 +00:00
if( slideChanged || !previousSlide ) {
stopEmbeddedContent( previousSlide );
startEmbeddedContent( currentSlide );
}
// Announce the current slide contents, for screen readers
2016-10-05 10:00:21 +00:00
dom.statusDiv.textContent = getStatusText( currentSlide );
updateControls();
updateProgress();
updateBackground();
updateParallax();
updateSlideNumber();
updateNotes();
2018-10-11 09:24:54 +00:00
updateFragments();
2013-07-19 13:23:17 +00:00
// Update the URL hash
writeURL();
cueAutoSlide();
2020-02-01 18:11:52 +00:00
// Auto-animation
if( slideChanged && previousSlide && currentSlide && !isOverview() ) {
2020-02-01 18:11:52 +00:00
// Skip the slide transition between our two slides
// when auto-animating individual elements
if( previousSlide.hasAttribute( 'data-auto-animate' ) && currentSlide.hasAttribute( 'data-auto-animate' ) ) {
dom.slides.classList.add( 'disable-slide-transitions' );
2020-02-01 18:11:52 +00:00
2020-03-06 13:54:55 +00:00
setTimeout( () => {
dom.slides.classList.remove( 'disable-slide-transitions' );
2020-02-01 18:11:52 +00:00
}, 0 );
if( config.autoAnimate ) {
// Run the auto-animation between our slides
autoAnimate( previousSlide, currentSlide );
}
}
2020-02-01 18:11:52 +00:00
2020-01-31 09:46:28 +00:00
}
2011-06-07 19:10:59 +00:00
}
2013-04-27 20:09:38 +00:00
/**
* 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 the slide backgrounds
createBackgrounds();
// Write the current hash to the URL
writeURL();
sortAllFragments();
2013-11-25 20:40:24 +00:00
updateControls();
updateProgress();
updateSlideNumber();
updateSlidesVisibility();
updateBackground( true );
updateNotesVisibility();
updateNotes();
formatEmbeddedContent();
// Start or stop embedded content depending on global config
if( config.autoPlayMedia === false ) {
stopEmbeddedContent( currentSlide, { unloadIframes: false } );
}
else {
startEmbeddedContent( currentSlide );
}
2015-01-27 08:21:49 +00:00
if( isOverview() ) {
layoutOverview();
}
2013-04-27 20:09:38 +00:00
}
2018-05-03 13:25:54 +00:00
/**
* 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
*/
2020-03-06 16:40:11 +00:00
function syncSlide( slide = currentSlide ) {
2018-05-03 13:25:54 +00:00
syncBackground( slide );
2018-05-31 08:35:07 +00:00
syncFragments( slide );
2018-05-03 13:25:54 +00:00
loadSlide( slide );
2018-05-03 13:25:54 +00:00
updateBackground();
updateNotes();
}
2018-05-31 08:35:07 +00:00
/**
* Formats the fragments on the given slide so that they have
* valid indices. Call this if fragments are changed in the DOM
* after reveal.js has already initialized.
*
* @param {HTMLElement} slide
* @return {Array} a list of the HTML fragments that were synced
2018-05-31 08:35:07 +00:00
*/
2020-03-06 16:40:11 +00:00
function syncFragments( slide = currentSlide ) {
return sortFragments( slide.querySelectorAll( '.fragment' ) );
2018-05-31 08:35:07 +00:00
}
2013-11-25 20:40:24 +00:00
/**
* Resets all vertical slides so that only the first
* is visible.
2013-11-25 20:40:24 +00:00
*/
function resetVerticalSlides() {
2013-11-25 20:40:24 +00:00
2020-03-07 10:58:18 +00:00
getHorizontalSlides().forEach( horizontalSlide => {
2013-11-25 20:40:24 +00:00
2020-03-06 16:40:11 +00:00
toArray( horizontalSlide.querySelectorAll( 'section' ) ).forEach( ( verticalSlide, y ) => {
2013-11-25 20:40:24 +00:00
if( y > 0 ) {
verticalSlide.classList.remove( 'present' );
verticalSlide.classList.remove( 'past' );
verticalSlide.classList.add( 'future' );
verticalSlide.setAttribute( 'aria-hidden', 'true' );
}
} );
} );
}
/**
* Sorts and formats all of fragments in the
* presentation.
*/
function sortAllFragments() {
2020-03-06 16:40:11 +00:00
getHorizontalSlides().forEach( horizontalSlide => {
2020-03-06 16:40:11 +00:00
let verticalSlides = toArray( horizontalSlide.querySelectorAll( 'section' ) );
verticalSlides.forEach( ( verticalSlide, y ) => {
2013-11-25 20:40:24 +00:00
sortFragments( verticalSlide.querySelectorAll( '.fragment' ) );
} );
if( verticalSlides.length === 0 ) sortFragments( horizontalSlide.querySelectorAll( '.fragment' ) );
} );
}
/**
* Randomly shuffles all slides in the deck.
*/
function shuffle() {
2020-03-06 16:40:11 +00:00
getHorizontalSlides().forEach( ( slide, i, slides ) => {
// Insert this slide next to another random slide. This may
// cause the slide to insert before itself but that's fine.
dom.slides.insertBefore( slide, slides[ Math.floor( Math.random() * slides.length ) ] );
} );
}
/**
* Updates one dimension of slides by showing the slide
* with the specified index.
*
2016-06-30 03:10:55 +00:00
* @param {string} selector A CSS selector that will fetch
* the group of slides we are working with
2016-06-30 03:10:55 +00:00
* @param {number} index The index of the slide that should be
* shown
*
2016-06-30 03:10:55 +00:00
* @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
2020-03-06 16:40:11 +00:00
let slides = toArray( dom.wrapper.querySelectorAll( selector ) ),
slidesLength = slides.length;
2020-03-06 16:40:11 +00:00
let printMode = isPrintingPDF();
if( slidesLength ) {
// Should the index loop?
if( config.loop ) {
index %= slidesLength;
if( index < 0 ) {
index = slidesLength + index;
}
}
// Enforce max and minimum index bounds
index = Math.max( Math.min( index, slidesLength - 1 ), 0 );
2020-03-06 16:40:11 +00:00
for( let i = 0; i < slidesLength; i++ ) {
let element = slides[i];
2020-03-06 16:40:11 +00:00
let reverse = config.rtl && !isVerticalSlide( element );
2020-03-06 16:40:11 +00:00
element.classList.remove( 'past', 'present', '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' );
2014-03-25 13:28:22 +00:00
if( config.fragments ) {
2018-10-11 09:32:16 +00:00
// Show all fragments in prior slides
2020-03-06 16:40:11 +00:00
toArray( element.querySelectorAll( '.fragment' ) ).forEach( fragment => {
2018-10-11 09:32:16 +00:00
fragment.classList.add( 'visible' );
fragment.classList.remove( 'current-fragment' );
} );
}
}
else if( i > index ) {
// Any element subsequent to index is given the 'future' class
element.classList.add( reverse ? 'past' : 'future' );
2014-03-25 13:28:22 +00:00
if( config.fragments ) {
2018-10-11 09:32:16 +00:00
// Hide all fragments in future slides
2020-03-06 16:40:11 +00:00
toArray( element.querySelectorAll( '.fragment.visible' ) ).forEach( fragment => {
fragment.classList.remove( 'visible', 'current-fragment' );
2018-10-11 09:32:16 +00:00
} );
}
}
}
// Mark the current slide as present
slides[index].classList.add( 'present' );
slides[index].removeAttribute( 'hidden' );
slides[index].removeAttribute( 'aria-hidden' );
// If this slide has a state associated with it, add it
// onto the current state of the deck
2020-03-06 16:40:11 +00:00
let slideState = slides[index].getAttribute( 'data-state' );
if( slideState ) {
state = state.concat( slideState.split( ' ' ) );
}
}
else {
// Since there are no slides we can't be anywhere beyond the
// zeroth index
index = 0;
}
return index;
}
/**
* Optimization method; hide all slides that are far away
* from the present slide.
*/
function updateSlidesVisibility() {
// Select all slides and convert the NodeList result to
// an array
2020-03-06 16:40:11 +00:00
let horizontalSlides = getHorizontalSlides(),
horizontalSlidesLength = horizontalSlides.length,
distanceX,
distanceY;
if( horizontalSlidesLength && typeof indexh !== 'undefined' ) {
// The number of steps away from the present slide that will
// be visible
2020-03-06 16:40:11 +00:00
let viewDistance = isOverview() ? 10 : config.viewDistance;
2019-12-09 20:05:41 +00:00
// Shorten the view distance on devices that typically have
// less resources
if( isMobileDevice ) {
2019-10-18 11:37:16 +00:00
viewDistance = isOverview() ? 6 : config.mobileViewDistance;
}
// All slides need to be visible when exporting to PDF
if( isPrintingPDF() ) {
viewDistance = Number.MAX_VALUE;
}
2020-03-06 16:40:11 +00:00
for( let x = 0; x < horizontalSlidesLength; x++ ) {
let horizontalSlide = horizontalSlides[x];
2020-03-06 16:40:11 +00:00
let verticalSlides = toArray( horizontalSlide.querySelectorAll( 'section' ) ),
verticalSlidesLength = verticalSlides.length;
// Determine how far away this slide is from the present
distanceX = Math.abs( ( indexh || 0 ) - x ) || 0;
// If the presentation is looped, distance should measure
// 1 between the first and last slides
if( config.loop ) {
2015-02-09 08:35:05 +00:00
distanceX = Math.abs( ( ( indexh || 0 ) - x ) % ( horizontalSlidesLength - viewDistance ) ) || 0;
}
2013-08-18 04:01:28 +00:00
// Show the horizontal slide if it's within the view distance
if( distanceX < viewDistance ) {
loadSlide( horizontalSlide );
}
else {
unloadSlide( horizontalSlide );
}
2013-08-18 04:01:28 +00:00
if( verticalSlidesLength ) {
2020-03-06 16:40:11 +00:00
let oy = getPreviousVerticalIndex( horizontalSlide );
2020-03-06 16:40:11 +00:00
for( let y = 0; y < verticalSlidesLength; y++ ) {
let verticalSlide = verticalSlides[y];
distanceY = x === ( indexh || 0 ) ? Math.abs( ( indexv || 0 ) - y ) : Math.abs( y - oy );
if( distanceX + distanceY < viewDistance ) {
loadSlide( verticalSlide );
}
else {
unloadSlide( verticalSlide );
}
}
}
}
// Flag if there are ANY vertical slides, anywhere in the deck
if( hasVerticalSlides() ) {
dom.wrapper.classList.add( 'has-vertical-slides' );
}
else {
dom.wrapper.classList.remove( 'has-vertical-slides' );
}
// Flag if there are ANY horizontal slides, anywhere in the deck
if( hasHorizontalSlides() ) {
dom.wrapper.classList.add( 'has-horizontal-slides' );
}
else {
dom.wrapper.classList.remove( 'has-horizontal-slides' );
}
}
}
/**
2016-06-30 03:10:55 +00:00
* Pick up notes from the current slide and display them
* to the viewer.
*
2016-06-30 03:10:55 +00:00
* @see {@link config.showNotes}
*/
function updateNotes() {
if( config.showNotes && dom.speakerNotes && currentSlide && !isPrintingPDF() ) {
2017-05-18 14:03:20 +00:00
dom.speakerNotes.innerHTML = getSlideNotes() || '<span class="notes-placeholder">No notes on this slide.</span>';
}
}
/**
* Updates the visibility of the speaker notes sidebar that
* is used to share annotated slides. The notes sidebar is
* only visible if showNotes is true and there are notes on
* one or more slides in the deck.
*/
function updateNotesVisibility() {
if( config.showNotes && hasNotes() ) {
dom.wrapper.classList.add( 'show-notes' );
}
else {
dom.wrapper.classList.remove( 'show-notes' );
}
}
/**
* Checks if there are speaker notes for ANY slide in the
* presentation.
*/
function hasNotes() {
return dom.slides.querySelectorAll( '[data-notes], aside.notes' ).length > 0;
}
/**
* Updates the progress bar to reflect the current slide.
*/
function updateProgress() {
// Update progress if enabled
if( config.progress && dom.progressbar ) {
dom.progressbar.style.width = getProgress() * dom.wrapper.offsetWidth + 'px';
}
}
/**
2019-02-01 09:15:10 +00:00
* Updates the slide number to match the current slide.
*/
function updateSlideNumber() {
// Update slide number if enabled
if( config.slideNumber && dom.slideNumber ) {
2019-03-02 17:21:29 +00:00
dom.slideNumber.innerHTML = getSlideNumber();
}
2019-03-02 17:21:29 +00:00
}
2019-03-02 17:21:29 +00:00
/**
* Returns the HTML string corresponding to the current slide number,
* including formatting.
*/
2020-03-06 16:40:11 +00:00
function getSlideNumber( slide = currentSlide ) {
2020-03-06 16:40:11 +00:00
let value;
let format = 'h.v';
2019-03-02 17:21:29 +00:00
if ( typeof config.slideNumber === 'function' ) {
value = config.slideNumber( slide );
} else {
// Check if a custom number format is available
if( typeof config.slideNumber === 'string' ) {
format = config.slideNumber;
2015-10-29 09:58:06 +00:00
}
2019-03-02 17:21:29 +00:00
// If there are ONLY vertical slides in this deck, always use
// a flattened slide number
if( !/c/.test( format ) && dom.wrapper.querySelectorAll( HORIZONTAL_SLIDES_SELECTOR ).length === 1 ) {
format = 'c';
2015-10-29 09:58:06 +00:00
}
2019-03-02 17:21:29 +00:00
value = [];
switch( format ) {
case 'c':
value.push( getSlidePastCount( slide ) + 1 );
break;
case 'c/t':
value.push( getSlidePastCount( slide ) + 1, '/', getTotalSlides() );
break;
default:
2020-03-06 16:40:11 +00:00
let indices = getIndices( slide );
2019-03-02 17:21:29 +00:00
value.push( indices.h + 1 );
2020-03-06 16:40:11 +00:00
let sep = format === 'h/v' ? '/' : '.';
2019-03-02 17:21:29 +00:00
if( isVerticalSlide( slide ) ) value.push( sep, indices.v + 1 );
}
}
2020-03-06 16:40:11 +00:00
let url = '#' + locationHash( slide );
2019-03-02 17:21:29 +00:00
return formatSlideNumber( value[0], value[1], value[2], url );
}
/**
* Applies HTML formatting to a slide number before it's
* written to the DOM.
2016-06-30 03:10:55 +00:00
*
* @param {number} a Current slide
* @param {string} delimiter Character to separate slide numbers
* @param {(number|*)} b Total slides
2019-03-02 17:21:29 +00:00
* @param {HTMLElement} [url='#'+locationHash()] The url to link to
2016-06-30 03:10:55 +00:00
* @return {string} HTML string fragment
*/
2020-03-06 16:40:11 +00:00
function formatSlideNumber( a, delimiter, b, url = '#' + locationHash() ) {
if( typeof b === 'number' && !isNaN( b ) ) {
2020-03-06 16:40:11 +00:00
return `<a href="${url}">
<span class="slide-number-a">${a}</span>
<span class="slide-number-delimiter">${delimiter}</span>
<span class="slide-number-b">${b}</span>
</a>`;
}
else {
2020-03-06 16:40:11 +00:00
return `<a href="${url}">
<span class="slide-number-a">${a}</span>
</a>`;
}
}
/**
* Updates the state of all control/navigation arrows.
*/
function updateControls() {
2020-03-06 16:40:11 +00:00
let routes = availableRoutes();
let fragments = availableFragments();
// Remove the 'enabled' class from all directions
2020-03-06 16:40:11 +00:00
[...dom.controlsLeft, ...dom.controlsRight, ...dom.controlsUp, ...dom.controlsDown, ...dom.controlsPrev, ...dom.controlsNext].forEach( node => {
node.classList.remove( 'enabled', 'fragmented' );
2016-05-23 08:54:40 +00:00
// Set 'disabled' attribute on all directions
2016-05-23 08:54:40 +00:00
node.setAttribute( 'disabled', 'disabled' );
} );
// Add the 'enabled' class to the available routes; remove 'disabled' attribute to enable buttons
2020-03-06 16:40:11 +00:00
if( routes.left ) dom.controlsLeft.forEach( el => { el.classList.add( 'enabled' ); el.removeAttribute( 'disabled' ); } );
if( routes.right ) dom.controlsRight.forEach( el => { el.classList.add( 'enabled' ); el.removeAttribute( 'disabled' ); } );
if( routes.up ) dom.controlsUp.forEach( el => { el.classList.add( 'enabled' ); el.removeAttribute( 'disabled' ); } );
if( routes.down ) dom.controlsDown.forEach( el => { el.classList.add( 'enabled' ); el.removeAttribute( 'disabled' ); } );
// Prev/next buttons
2020-03-06 16:40:11 +00:00
if( routes.left || routes.up ) dom.controlsPrev.forEach( el => { el.classList.add( 'enabled' ); el.removeAttribute( 'disabled' ); } );
if( routes.right || routes.down ) dom.controlsNext.forEach( el => { el.classList.add( 'enabled' ); el.removeAttribute( 'disabled' ); } );
// Highlight fragment directions
if( currentSlide ) {
// Always apply fragment decorator to prev/next buttons
2020-03-06 16:40:11 +00:00
if( fragments.prev ) dom.controlsPrev.forEach( el => { el.classList.add( 'fragmented', 'enabled' ); el.removeAttribute( 'disabled' ); } );
if( fragments.next ) dom.controlsNext.forEach( el => { el.classList.add( 'fragmented', 'enabled' ); el.removeAttribute( 'disabled' ); } );
// Apply fragment decorators to directional buttons based on
// what slide axis they are in
if( isVerticalSlide( currentSlide ) ) {
2020-03-06 16:40:11 +00:00
if( fragments.prev ) dom.controlsUp.forEach( el => { el.classList.add( 'fragmented', 'enabled' ); el.removeAttribute( 'disabled' ); } );
if( fragments.next ) dom.controlsDown.forEach( el => { el.classList.add( 'fragmented', 'enabled' ); el.removeAttribute( 'disabled' ); } );
}
else {
2020-03-06 16:40:11 +00:00
if( fragments.prev ) dom.controlsLeft.forEach( el => { el.classList.add( 'fragmented', 'enabled' ); el.removeAttribute( 'disabled' ); } );
if( fragments.next ) dom.controlsRight.forEach( el => { el.classList.add( 'fragmented', 'enabled' ); el.removeAttribute( 'disabled' ); } );
}
2012-06-10 09:53:44 +00:00
}
2017-05-16 13:40:50 +00:00
if( config.controlsTutorial ) {
// Highlight control arrows with an animation to ensure
// that the viewer knows how to navigate
2020-02-06 14:19:09 +00:00
if( !hasNavigatedVertically && routes.down ) {
dom.controlsDownArrow.classList.add( 'highlight' );
}
else {
dom.controlsDownArrow.classList.remove( 'highlight' );
2020-02-06 14:19:09 +00:00
if( config.rtl ) {
2020-02-06 14:19:09 +00:00
if( !hasNavigatedHorizontally && routes.left && indexv === 0 ) {
dom.controlsLeftArrow.classList.add( 'highlight' );
}
else {
dom.controlsLeftArrow.classList.remove( 'highlight' );
}
} else {
2020-02-06 14:19:09 +00:00
if( !hasNavigatedHorizontally && routes.right && indexv === 0 ) {
dom.controlsRightArrow.classList.add( 'highlight' );
}
else {
dom.controlsRightArrow.classList.remove( 'highlight' );
}
}
}
}
}
/**
* Updates the background elements to reflect the current
* slide.
*
2016-06-30 03:10:55 +00:00
* @param {boolean} includeAll If true, the backgrounds of
* all vertical slides (not just the present) will be updated.
*/
2020-03-06 16:40:11 +00:00
function updateBackground( includeAll = false ) {
2020-03-06 16:40:11 +00:00
let currentBackground = null;
// Reverse past/future classes when in RTL mode
2020-03-06 16:40:11 +00:00
let horizontalPast = config.rtl ? 'future' : 'past',
horizontalFuture = config.rtl ? 'past' : 'future';
// Update the classes of all backgrounds to match the
// states of their slides (past/present/future)
2020-03-06 16:40:11 +00:00
toArray( dom.background.childNodes ).forEach( ( backgroundh, h ) => {
2020-03-06 16:40:11 +00:00
backgroundh.classList.remove( 'past', 'present', 'future' );
if( h < indexh ) {
backgroundh.classList.add( horizontalPast );
}
else if ( h > indexh ) {
backgroundh.classList.add( horizontalFuture );
}
else {
backgroundh.classList.add( 'present' );
// Store a reference to the current background element
currentBackground = backgroundh;
}
if( includeAll || h === indexh ) {
2020-03-06 16:40:11 +00:00
toArray( backgroundh.querySelectorAll( '.slide-background' ) ).forEach( ( backgroundv, v ) => {
2020-03-06 16:40:11 +00:00
backgroundv.classList.remove( 'past', 'present', 'future' );
if( v < indexv ) {
backgroundv.classList.add( 'past' );
}
else if ( v > indexv ) {
backgroundv.classList.add( 'future' );
}
else {
backgroundv.classList.add( 'present' );
// Only if this is the present horizontal and vertical slide
if( h === indexh ) currentBackground = backgroundv;
}
} );
}
} );
// Stop content inside of previous backgrounds
2014-04-04 07:22:15 +00:00
if( previousBackground ) {
stopEmbeddedContent( previousBackground, { unloadIframes: !shouldPreload( previousBackground ) } );
2014-04-04 07:22:15 +00:00
}
// Start content in the current background
if( currentBackground ) {
2014-04-04 07:22:15 +00:00
2017-01-19 11:08:28 +00:00
startEmbeddedContent( currentBackground );
2014-04-04 07:22:15 +00:00
2020-03-06 16:40:11 +00:00
let currentBackgroundContent = currentBackground.querySelector( '.slide-background-content' );
if( currentBackgroundContent ) {
2020-03-06 16:40:11 +00:00
let backgroundImageURL = currentBackgroundContent.style.backgroundImage || '';
// Restart GIFs (doesn't work in Firefox)
if( /\.gif/i.test( backgroundImageURL ) ) {
currentBackgroundContent.style.backgroundImage = '';
window.getComputedStyle( currentBackgroundContent ).opacity;
currentBackgroundContent.style.backgroundImage = backgroundImageURL;
}
}
2014-04-04 07:22:15 +00:00
// Don't transition between identical backgrounds. This
// prevents unwanted flicker.
2020-03-06 16:40:11 +00:00
let previousBackgroundHash = previousBackground ? previousBackground.getAttribute( 'data-background-hash' ) : null;
let currentBackgroundHash = currentBackground.getAttribute( 'data-background-hash' );
if( currentBackgroundHash && currentBackgroundHash === previousBackgroundHash && currentBackground !== previousBackground ) {
dom.background.classList.add( 'no-transition' );
}
previousBackground = currentBackground;
2014-04-04 07:22:15 +00:00
}
2014-09-10 08:12:25 +00:00
// If there's a background brightness flag for this slide,
// bubble it to the .reveal container
if( currentSlide ) {
2020-03-06 16:40:11 +00:00
[ 'has-light-background', 'has-dark-background' ].forEach( classToBubble => {
2014-09-10 08:12:25 +00:00
if( currentSlide.classList.contains( classToBubble ) ) {
dom.wrapper.classList.add( classToBubble );
}
else {
dom.wrapper.classList.remove( classToBubble );
}
} );
}
// Allow the first background to apply without transition
2020-03-06 16:40:11 +00:00
setTimeout( () => {
dom.background.classList.remove( 'no-transition' );
}, 1 );
}
/**
* Updates the position of the parallax background based
* on the current slide index.
*/
function updateParallax() {
if( config.parallaxBackgroundImage ) {
2020-03-06 16:40:11 +00:00
let horizontalSlides = getHorizontalSlides(),
verticalSlides = getVerticalSlides();
2020-03-06 16:40:11 +00:00
let backgroundSize = dom.background.style.backgroundSize.split( ' ' ),
backgroundWidth, backgroundHeight;
if( backgroundSize.length === 1 ) {
backgroundWidth = backgroundHeight = parseInt( backgroundSize[0], 10 );
}
else {
backgroundWidth = parseInt( backgroundSize[0], 10 );
backgroundHeight = parseInt( backgroundSize[1], 10 );
}
2020-03-06 16:40:11 +00:00
let slideWidth = dom.background.offsetWidth,
horizontalSlideCount = horizontalSlides.length,
horizontalOffsetMultiplier,
horizontalOffset;
if( typeof config.parallaxBackgroundHorizontal === 'number' ) {
horizontalOffsetMultiplier = config.parallaxBackgroundHorizontal;
}
else {
2015-11-19 09:38:52 +00:00
horizontalOffsetMultiplier = horizontalSlideCount > 1 ? ( backgroundWidth - slideWidth ) / ( horizontalSlideCount-1 ) : 0;
}
horizontalOffset = horizontalOffsetMultiplier * indexh * -1;
2020-03-06 16:40:11 +00:00
let slideHeight = dom.background.offsetHeight,
verticalSlideCount = verticalSlides.length,
verticalOffsetMultiplier,
verticalOffset;
if( typeof config.parallaxBackgroundVertical === 'number' ) {
verticalOffsetMultiplier = config.parallaxBackgroundVertical;
}
else {
verticalOffsetMultiplier = ( backgroundHeight - slideHeight ) / ( verticalSlideCount-1 );
}
2016-06-30 03:10:55 +00:00
verticalOffset = verticalSlideCount > 0 ? verticalOffsetMultiplier * indexv : 0;
dom.background.style.backgroundPosition = horizontalOffset + 'px ' + -verticalOffset + 'px';
}
}
2020-01-31 09:46:28 +00:00
/**
* Runs an auto-animation between the given slides.
*
* @param {HTMLElement} fromSlide
* @param {HTMLElement} toSlide
*/
function autoAnimate( fromSlide, toSlide ) {
// Clean up after prior animations
removeEphemeralAutoAnimateAttributes();
2020-02-13 08:55:33 +00:00
if( autoAnimateStyleSheet && autoAnimateStyleSheet.parentNode ) {
autoAnimateStyleSheet.parentNode.removeChild( autoAnimateStyleSheet );
autoAnimateStyleSheet = null;
}
2020-02-01 18:11:52 +00:00
// Ensure that both slides are auto-animate targets
if( fromSlide.hasAttribute( 'data-auto-animate' ) && toSlide.hasAttribute( 'data-auto-animate' ) ) {
2020-02-13 08:55:33 +00:00
// Create a new auto-animate sheet
autoAnimateStyleSheet = autoAnimateStyleSheet || document.createElement( 'style' );
autoAnimateStyleSheet.type = 'text/css';
document.head.appendChild( autoAnimateStyleSheet );
2020-03-05 19:32:35 +00:00
let animationOptions = getAutoAnimateOptions( toSlide );
// Set our starting state
fromSlide.dataset.autoAnimate = 'pending';
toSlide.dataset.autoAnimate = 'pending';
// Inject our auto-animate styles for this transition
2020-03-07 10:58:18 +00:00
let css = getAutoAnimatableElements( fromSlide, toSlide ).map( elements => {
return getAutoAnimateCSS( elements.from, elements.to, elements.options || {}, animationOptions, autoAnimateCounter++ );
} );
// Animate unmatched elements, if enabled
if( toSlide.dataset.autoAnimateUnmatched !== 'false' && config.autoAnimateUnmatched === true ) {
2020-03-07 10:58:18 +00:00
getUnmatchedAutoAnimateElements( toSlide ).forEach( unmatchedElement => {
unmatchedElement.dataset.autoAnimateTarget = 'unmatched';
} );
2020-03-05 19:32:35 +00:00
css.push( `[data-auto-animate="running"] [data-auto-animate-target="unmatched"] { transition: opacity ${animationOptions.duration*0.8}s ease ${animationOptions.duration*0.2}s; }` );
}
2020-01-31 09:46:28 +00:00
// Setting the whole chunk of CSS at once is the most
// efficient way to do this. Using sheet.insertRule
// is multiple factors slower.
autoAnimateStyleSheet.innerHTML = css.join( '' );
// Start the animation next cycle
2020-03-05 19:32:35 +00:00
requestAnimationFrame( () => {
2020-02-17 09:19:47 +00:00
if( autoAnimateStyleSheet ) {
// This forces our newly injected styles to be applied in Firefox
getComputedStyle( autoAnimateStyleSheet ).fontWeight;
2020-02-17 09:19:47 +00:00
toSlide.dataset.autoAnimate = 'running';
}
} );
dispatchEvent( 'autoanimate', { fromSlide: fromSlide, toSlide: toSlide, sheet: autoAnimateStyleSheet } );
}
2020-01-31 09:46:28 +00:00
}
/**
* Removes all attributes that we temporarily add to slide
* elements in order to carry out auto-animation.
*/
function removeEphemeralAutoAnimateAttributes() {
2020-03-05 19:32:35 +00:00
toArray( dom.wrapper.querySelectorAll( '[data-auto-animate-target]' ) ).forEach( element => {
delete element.dataset.autoAnimateTarget;
} );
}
2020-01-31 09:46:28 +00:00
/**
* Auto-animates the properties of an element from their original
* values to their new state.
*
2020-02-01 18:11:52 +00:00
* @param {HTMLElement} from
* @param {HTMLElement} to
* @param {Object} elementOptions Options for this element pair
* @param {Object} animationOptions Options set at the slide level
* @param {String} id Unique ID that we can use to identify this
* auto-animate element in the DOM
2020-01-31 09:46:28 +00:00
*/
function getAutoAnimateCSS( from, to, elementOptions, animationOptions, id ) {
2020-01-31 09:46:28 +00:00
// 'from' elements are given a data-auto-animate-target with no value,
// 'to' elements are are given a data-auto-animate-target with an ID
from.dataset.autoAnimateTarget = '';
to.dataset.autoAnimateTarget = id;
2020-01-31 09:46:28 +00:00
// Each element may override any of the auto-animate options
2020-02-11 17:37:14 +00:00
// like transition easing, duration and delay via data-attributes
2020-03-05 19:32:35 +00:00
let options = getAutoAnimateOptions( to, animationOptions );
2020-02-11 17:37:14 +00:00
// If we're using a custom element matcher the element options
// may contain additional transition overrides
if( typeof elementOptions.delay !== 'undefined' ) options.delay = elementOptions.delay;
if( typeof elementOptions.duration !== 'undefined' ) options.duration = elementOptions.duration;
if( typeof elementOptions.easing !== 'undefined' ) options.easing = elementOptions.easing;
2020-03-05 19:32:35 +00:00
let fromProps = getAutoAnimatableProperties( 'from', from, elementOptions ),
toProps = getAutoAnimatableProperties( 'to', to, elementOptions );
2020-01-31 09:46:28 +00:00
2020-02-11 18:15:45 +00:00
// If translation and/or scaling are enabled, css transform
// the 'to' element so that it matches the position and size
// of the 'from' element
if( elementOptions.translate !== false || elementOptions.scale !== false ) {
2020-03-05 19:32:35 +00:00
let presentationScale = Reveal.getScale();
2020-03-05 19:32:35 +00:00
let delta = {
x: ( fromProps.x - toProps.x ) / presentationScale,
y: ( fromProps.y - toProps.y ) / presentationScale,
scaleX: fromProps.width / toProps.width,
scaleY: fromProps.height / toProps.height
};
2020-01-31 09:46:28 +00:00
// Limit decimal points to avoid 0.0001px blur and stutter
delta.x = Math.round( delta.x * 1000 ) / 1000;
delta.y = Math.round( delta.y * 1000 ) / 1000;
delta.scaleX = Math.round( delta.scaleX * 1000 ) / 1000;
delta.scaleX = Math.round( delta.scaleX * 1000 ) / 1000;
2020-03-05 19:32:35 +00:00
let translate = elementOptions.translate !== false && ( delta.x !== 0 || delta.y !== 0 ),
scale = elementOptions.scale !== false && ( delta.scaleX !== 0 || delta.scaleY !== 0 );
// No need to transform if nothing's changed
if( translate || scale ) {
2020-03-05 19:32:35 +00:00
let transform = [];
2020-01-31 09:46:28 +00:00
2020-03-06 16:40:11 +00:00
if( translate ) transform.push( `translate(${delta.x}px, ${delta.y}px)` );
if( scale ) transform.push( `scale(${delta.scaleX}, ${delta.scaleY})` );
fromProps.styles['transform'] = transform.join( ' ' );
fromProps.styles['transform-origin'] = 'top left';
toProps.styles['transform'] = 'none';
}
}
// Delete all unchanged 'to' styles
2020-03-05 19:32:35 +00:00
for( let propertyName in toProps.styles ) {
const toValue = toProps.styles[propertyName];
const fromValue = fromProps.styles[propertyName];
if( toValue === fromValue ) {
delete toProps.styles[propertyName];
}
else {
// If these property values were set via a custom matcher providing
// an explicit 'from' and/or 'to' value, we always inject those values.
if( toValue.explicitValue === true ) {
toProps.styles[propertyName] = toValue.value;
}
if( fromValue.explicitValue === true ) {
fromProps.styles[propertyName] = fromValue.value;
}
}
2020-02-13 08:59:28 +00:00
}
2020-03-05 19:32:35 +00:00
let css = '';
2020-03-05 19:32:35 +00:00
let toStyleProperties = Object.keys( toProps.styles );
// Only create animate this element IF at least one style
// property has changed
if( toStyleProperties.length > 0 ) {
// Instantly move to the 'from' state
fromProps.styles['transition'] = 'none';
// Animate towards the 'to' state
2020-03-05 19:32:35 +00:00
toProps.styles['transition'] = `all ${options.duration}s ${options.easing} ${options.delay}s`;
toProps.styles['transition-property'] = toStyleProperties.join( ', ' );
toProps.styles['will-change'] = toStyleProperties.join( ', ' );
2020-01-31 09:46:28 +00:00
// Build up our custom CSS. We need to override inline styles
// so we need to make our styles vErY IMPORTANT!1!!
2020-03-07 10:58:18 +00:00
let fromCSS = Object.keys( fromProps.styles ).map( propertyName => {
return propertyName + ': ' + fromProps.styles[propertyName] + ' !important;';
} ).join( '' );
2020-03-07 10:58:18 +00:00
let toCSS = Object.keys( toProps.styles ).map( propertyName => {
return propertyName + ': ' + toProps.styles[propertyName] + ' !important;';
} ).join( '' );
css = '[data-auto-animate-target="'+ id +'"] {'+ fromCSS +'}' +
'[data-auto-animate="running"] [data-auto-animate-target="'+ id +'"] {'+ toCSS +'}';
}
return css;
2020-01-31 09:46:28 +00:00
}
2020-02-11 17:37:14 +00:00
/**
* Returns the auto-animate options for the given element.
*
* @param {HTMLElement} element Element to pick up options
* from, either a slide or an animation target
* @param {Object} [inheritedOptions] Optional set of existing
* options
2020-02-11 17:37:14 +00:00
*/
function getAutoAnimateOptions( element, inheritedOptions ) {
2020-02-11 17:37:14 +00:00
2020-03-05 19:32:35 +00:00
let options = {
2020-02-11 17:37:14 +00:00
easing: config.autoAnimateEasing,
duration: config.autoAnimateDuration,
delay: 0
};
options = extend( options, inheritedOptions );
// Inherit options from parent elements
if( element.closest && element.parentNode ) {
2020-03-05 19:32:35 +00:00
let autoAnimatedParent = element.parentNode.closest( '[data-auto-animate-target]' );
if( autoAnimatedParent ) {
options = getAutoAnimateOptions( autoAnimatedParent, options );
}
}
2020-02-11 17:37:14 +00:00
if( element.dataset.autoAnimateEasing ) {
options.easing = element.dataset.autoAnimateEasing;
}
if( element.dataset.autoAnimateDuration ) {
options.duration = parseFloat( element.dataset.autoAnimateDuration );
}
if( element.dataset.autoAnimateDelay ) {
options.delay = parseFloat( element.dataset.autoAnimateDelay );
}
return options;
}
2020-01-31 09:46:28 +00:00
/**
* Returns an object containing all of the properties
2020-02-11 17:37:14 +00:00
* that can be auto-animated for the given element and
* their current computed values.
*
* @param {String} direction 'from' or 'to'
2020-01-31 09:46:28 +00:00
*/
function getAutoAnimatableProperties( direction, element, elementOptions ) {
2020-01-31 09:46:28 +00:00
2020-03-05 19:32:35 +00:00
let properties = { styles: [] };
2020-01-31 09:46:28 +00:00
// Position and size
if( elementOptions.translate !== false || elementOptions.scale !== false ) {
2020-03-05 19:32:35 +00:00
let bounds;
// Custom auto-animate may optionally return a custom tailored
// measurement function
if( typeof elementOptions.measure === 'function' ) {
bounds = elementOptions.measure( element );
}
else {
bounds = element.getBoundingClientRect();
}
properties.x = bounds.x;
properties.y = bounds.y;
properties.width = bounds.width;
properties.height = bounds.height;
}
2020-01-31 09:46:28 +00:00
2020-03-05 19:32:35 +00:00
const computedStyles = getComputedStyle( element );
2020-01-31 09:46:28 +00:00
// CSS styles
2020-03-05 19:32:35 +00:00
( elementOptions.styles || config.autoAnimateStyles ).forEach( style => {
let value;
2020-01-31 09:46:28 +00:00
// `style` is either the property name directly, or an object
// definition of a style property
if( typeof style === 'string' ) style = { property: style };
if( typeof style.from !== 'undefined' && direction === 'from' ) {
value = { value: style.from, explicitValue: true };
}
else if( typeof style.to !== 'undefined' && direction === 'to' ) {
value = { value: style.to, explicitValue: true };
}
else {
value = computedStyles[style.property];
}
2020-02-01 18:11:52 +00:00
if( value !== '' ) {
properties.styles[style.property] = value;
}
} );
2020-01-31 09:46:28 +00:00
return properties;
}
/**
* Get a list of all element pairs that we can animate
* between the given slides.
*
* @param {HTMLElement} fromSlide
* @param {HTMLElement} toSlide
*
* @return {Array} Each value is an array where [0] is
* the element we're animating from and [1] is the
* element we're animating to
*/
function getAutoAnimatableElements( fromSlide, toSlide ) {
2020-03-05 19:32:35 +00:00
let matcher = typeof config.autoAnimateMatcher === 'function' ? config.autoAnimateMatcher : getAutoAnimatePairs;
2020-03-05 19:32:35 +00:00
let pairs = matcher( fromSlide, toSlide );
2020-03-05 19:32:35 +00:00
let reserved = [];
// Remove duplicate pairs
2020-03-05 19:32:35 +00:00
return pairs.filter( ( pair, index ) => {
if( reserved.indexOf( pair.to ) === -1 ) {
reserved.push( pair.to );
return true;
}
} );
}
/**
* Identifies matching elements between slides.
*
* You can specify a custom matcher function by using
2020-02-11 17:37:14 +00:00
* the `autoAnimateMatcher` config option.
*/
function getAutoAnimatePairs( fromSlide, toSlide ) {
2020-03-05 19:32:35 +00:00
let pairs = [];
2020-03-05 19:32:35 +00:00
const codeNodes = 'pre';
const textNodes = 'h1, h2, h3, h4, h5, h6, p, li';
const mediaNodes = 'img, video, iframe';
// Eplicit matches via data-id
2020-03-05 19:32:35 +00:00
findAutoAnimateMatches( pairs, fromSlide, toSlide, '[data-id]', node => {
return node.nodeName + ':::' + node.getAttribute( 'data-id' );
} );
// Text
2020-03-05 19:32:35 +00:00
findAutoAnimateMatches( pairs, fromSlide, toSlide, textNodes, node => {
return node.nodeName + ':::' + node.innerText;
} );
// Media
2020-03-05 19:32:35 +00:00
findAutoAnimateMatches( pairs, fromSlide, toSlide, mediaNodes, node => {
return node.nodeName + ':::' + ( node.getAttribute( 'src' ) || node.getAttribute( 'data-src' ) );
} );
// Code
2020-03-05 19:32:35 +00:00
findAutoAnimateMatches( pairs, fromSlide, toSlide, codeNodes, node => {
return node.nodeName + ':::' + node.innerText;
} );
2020-03-05 19:32:35 +00:00
pairs.forEach( pair => {
// Disable scale transformations on text nodes, we transiition
// each individual text property instead
if( pair.from.matches( textNodes ) ) {
2020-02-11 18:15:45 +00:00
pair.options = { scale: false };
}
// Animate individual lines of code
else if( pair.from.matches( codeNodes ) ) {
// Transition the code block's width and height instead of scaling
// to prevent its content from being squished
pair.options = { scale: false, styles: [ 'width', 'height' ] };
// Lines of code
2020-03-05 19:32:35 +00:00
findAutoAnimateMatches( pairs, pair.from, pair.to, '.hljs .hljs-ln-code', node => {
return node.textContent;
}, {
scale: false,
styles: [],
measure: getLocalBoundingBox
} );
// Line numbers
2020-03-05 19:32:35 +00:00
findAutoAnimateMatches( pairs, pair.from, pair.to, '.hljs .hljs-ln-line[data-line-number]', node => {
return node.getAttribute( 'data-line-number' );
}, {
scale: false,
styles: [ 'width' ],
measure: getLocalBoundingBox
} );
}
} );
return pairs;
}
/**
* Helper method which returns a bounding box based on
* the given elements offset coordinates.
*
* @param {HTMLElement} element
* @return {Object} x, y, width, height
*/
function getLocalBoundingBox( element ) {
2020-03-05 19:32:35 +00:00
const presentationScale = Reveal.getScale();
return {
x: Math.round( ( element.offsetLeft * presentationScale ) * 100 ) / 100,
y: Math.round( ( element.offsetTop * presentationScale ) * 100 ) / 100,
width: Math.round( ( element.offsetWidth * presentationScale ) * 100 ) / 100,
height: Math.round( ( element.offsetHeight * presentationScale ) * 100 ) / 100
};
}
/**
* Finds matching elements between two slides.
*
* @param {Array} pairs List of pairs to push matches to
* @param {HTMLElement} fromScope Scope within the from element exists
* @param {HTMLElement} toScope Scope within the to element exists
* @param {String} selector CSS selector of the element to match
* @param {Function} serializer A function that accepts an element and returns
* a stringified ID based on its contents
* @param {Object} animationOptions Optional config options for this pair
*/
function findAutoAnimateMatches( pairs, fromScope, toScope, selector, serializer, animationOptions ) {
2020-03-05 19:32:35 +00:00
let fromMatches = {};
let toMatches = {};
2020-03-05 19:32:35 +00:00
[].slice.call( fromScope.querySelectorAll( selector ) ).forEach( ( element, i ) => {
const key = serializer( element );
if( typeof key === 'string' && key.length ) {
fromMatches[key] = fromMatches[key] || [];
fromMatches[key].push( element );
}
} );
2020-03-05 19:32:35 +00:00
[].slice.call( toScope.querySelectorAll( selector ) ).forEach( ( element, i ) => {
const key = serializer( element );
toMatches[key] = toMatches[key] || [];
toMatches[key].push( element );
2020-03-05 19:32:35 +00:00
let fromElement;
// Retrieve the 'from' element
if( fromMatches[key] ) {
2020-03-05 19:32:35 +00:00
const pimaryIndex = toMatches[key].length - 1;
const secondaryIndex = fromMatches[key].length - 1;
// If there are multiple identical from elements, retrieve
// the one at the same index as our to-element.
if( fromMatches[key][ pimaryIndex ] ) {
fromElement = fromMatches[key][ pimaryIndex ];
fromMatches[key][ pimaryIndex ] = null;
}
// If there are no matching from-elements at the same index,
// use the last one.
else if( fromMatches[key][ secondaryIndex ] ) {
fromElement = fromMatches[key][ secondaryIndex ];
fromMatches[key][ secondaryIndex ] = null;
}
}
// If we've got a matching pair, push it to the list of pairs
if( fromElement ) {
pairs.push({
from: fromElement,
to: element,
options: animationOptions
});
}
} );
}
/**
* Returns a all elements within the given scope that should
* be considered unmatched in an auto-animate transition. If
* fading of unmatched elements is turned on, these elements
* will fade when going between auto-animate slides.
*
* Note that parents of auto-animate targets are NOT considerd
* unmatched since fading them would break the auto-animation.
*
* @param {HTMLElement} rootElement
* @return {Array}
*/
function getUnmatchedAutoAnimateElements( rootElement ) {
2020-03-05 19:32:35 +00:00
return [].slice.call( rootElement.children ).reduce( ( result, element ) => {
2020-03-05 19:32:35 +00:00
const containsAnimatedElements = element.querySelector( '[data-auto-animate-target]' );
// The element is unmatched if
// - It is not an auto-animate target
// - It does not contain any auto-animate targets
if( !element.hasAttribute( 'data-auto-animate-target' ) && !containsAnimatedElements ) {
result.push( element );
}
if( element.querySelector( '[data-auto-animate-target]' ) ) {
result = result.concat( getUnmatchedAutoAnimateElements( element ) );
}
return result;
}, [] );
}
/**
* Should the given element be preloaded?
* Decides based on local element attributes and global config.
*
* @param {HTMLElement} element
*/
2019-03-28 14:42:28 +00:00
function shouldPreload( element ) {
// Prefer an explicit global preload setting
2020-03-06 16:40:11 +00:00
let preload = config.preloadIframes;
// If no global setting is available, fall back on the element's
// own preload setting
if( typeof preload !== 'boolean' ) {
preload = element.hasAttribute( 'data-preload' );
}
return preload;
}
/**
* Called when the given slide is within the configured view
* distance. Shows the slide element and loads any content
* that is set to load lazily (data-src).
*
* @param {HTMLElement} slide Slide to show
*/
2020-03-06 16:40:11 +00:00
function loadSlide( slide, options = {} ) {
2014-04-27 13:39:11 +00:00
// Show the slide element
slide.style.display = config.display;
2014-04-22 13:52:44 +00:00
// Media elements with data-src attributes
2020-03-06 16:40:11 +00:00
toArray( slide.querySelectorAll( 'img[data-src], video[data-src], audio[data-src], iframe[data-src]' ) ).forEach( element => {
2019-03-28 14:42:28 +00:00
if( element.tagName !== 'IFRAME' || shouldPreload( element ) ) {
element.setAttribute( 'src', element.getAttribute( 'data-src' ) );
element.setAttribute( 'data-lazy-loaded', '' );
element.removeAttribute( 'data-src' );
}
} );
2014-04-27 12:46:49 +00:00
// Media elements with <source> children
2020-03-06 16:40:11 +00:00
toArray( slide.querySelectorAll( 'video, audio' ) ).forEach( media => {
2020-03-07 10:58:18 +00:00
let sources = 0;
2014-04-22 13:52:44 +00:00
2020-03-06 16:40:11 +00:00
toArray( media.querySelectorAll( 'source[data-src]' ) ).forEach( source => {
2014-04-22 13:52:44 +00:00
source.setAttribute( 'src', source.getAttribute( 'data-src' ) );
source.removeAttribute( 'data-src' );
source.setAttribute( 'data-lazy-loaded', '' );
2014-04-22 13:52:44 +00:00
sources += 1;
} );
2014-04-22 14:10:08 +00:00
// If we rewrote sources for this video/audio element, we need
// to manually tell it to load from its new origin
2014-04-22 13:52:44 +00:00
if( sources > 0 ) {
2014-04-22 14:10:08 +00:00
media.load();
2014-04-22 13:52:44 +00:00
}
} );
// Show the corresponding background element
2020-03-06 16:40:11 +00:00
let background = slide.slideBackgroundElement;
2014-04-28 10:31:34 +00:00
if( background ) {
background.style.display = 'block';
2020-03-06 16:40:11 +00:00
let backgroundContent = slide.slideBackgroundContentElement;
let backgroundIframe = slide.getAttribute( 'data-background-iframe' );
2014-04-28 10:31:34 +00:00
// If the background contains media, load it
if( background.hasAttribute( 'data-loaded' ) === false ) {
background.setAttribute( 'data-loaded', 'true' );
2020-03-06 16:40:11 +00:00
let backgroundImage = slide.getAttribute( 'data-background-image' ),
2014-10-09 10:34:10 +00:00
backgroundVideo = slide.getAttribute( 'data-background-video' ),
2015-02-19 06:34:41 +00:00
backgroundVideoLoop = slide.hasAttribute( 'data-background-video-loop' ),
backgroundVideoMuted = slide.hasAttribute( 'data-background-video-muted' );
2014-04-28 10:31:34 +00:00
// Images
if( backgroundImage ) {
backgroundContent.style.backgroundImage = 'url('+ encodeURI( backgroundImage ) +')';
2014-04-28 10:31:34 +00:00
}
// Videos
else if ( backgroundVideo && !isSpeakerNotes() ) {
2020-03-06 16:40:11 +00:00
let video = document.createElement( 'video' );
2015-02-25 14:52:10 +00:00
if( backgroundVideoLoop ) {
video.setAttribute( 'loop', '' );
}
if( backgroundVideoMuted ) {
video.muted = true;
}
// Inline video playback works (at least in Mobile Safari) as
// long as the video is muted and the `playsinline` attribute is
// present
if( isMobileDevice ) {
video.muted = true;
video.autoplay = true;
video.setAttribute( 'playsinline', '' );
}
// Support comma separated lists of video sources
2020-03-06 16:40:11 +00:00
backgroundVideo.split( ',' ).forEach( source => {
video.innerHTML += '<source src="'+ source +'">';
} );
backgroundContent.appendChild( video );
2014-04-28 10:31:34 +00:00
}
2014-10-09 10:34:10 +00:00
// Iframes
else if( backgroundIframe && options.excludeIframes !== true ) {
2020-03-06 16:40:11 +00:00
let iframe = document.createElement( 'iframe' );
iframe.setAttribute( 'allowfullscreen', '' );
iframe.setAttribute( 'mozallowfullscreen', '' );
iframe.setAttribute( 'webkitallowfullscreen', '' );
iframe.setAttribute( 'allow', 'autoplay' );
iframe.setAttribute( 'data-src', backgroundIframe );
iframe.style.width = '100%';
iframe.style.height = '100%';
iframe.style.maxHeight = '100%';
iframe.style.maxWidth = '100%';
2014-10-09 10:34:10 +00:00
backgroundContent.appendChild( iframe );
2014-10-09 10:34:10 +00:00
}
}
// Start loading preloadable iframes
2020-03-06 16:40:11 +00:00
let backgroundIframeElement = backgroundContent.querySelector( 'iframe[data-src]' );
if( backgroundIframeElement ) {
// Check if this iframe is eligible to be preloaded
if( shouldPreload( background ) && !/autoplay=(1|true|yes)/gi.test( backgroundIframe ) ) {
if( backgroundIframeElement.getAttribute( 'src' ) !== backgroundIframe ) {
backgroundIframeElement.setAttribute( 'src', backgroundIframe );
}
}
}
}
}
/**
* Unloads and hides the given slide. This is called when the
* slide is moved outside of the configured view distance.
2016-06-30 03:10:55 +00:00
*
* @param {HTMLElement} slide
*/
function unloadSlide( slide ) {
2014-04-27 13:39:11 +00:00
// Hide the slide element
slide.style.display = 'none';
2014-04-27 13:39:11 +00:00
// Hide the corresponding background element
2020-03-06 16:40:11 +00:00
let background = getSlideBackground( slide );
2014-04-28 10:31:34 +00:00
if( background ) {
background.style.display = 'none';
// Unload any background iframes
2020-03-06 16:40:11 +00:00
toArray( background.querySelectorAll( 'iframe[src]' ) ).forEach( element => {
element.removeAttribute( 'src' );
} );
2014-04-28 10:31:34 +00:00
}
2014-04-27 13:39:11 +00:00
// Reset lazy-loaded media elements with src attributes
2020-03-06 16:40:11 +00:00
toArray( slide.querySelectorAll( 'video[data-lazy-loaded][src], audio[data-lazy-loaded][src], iframe[data-lazy-loaded][src]' ) ).forEach( element => {
2019-03-28 14:42:28 +00:00
element.setAttribute( 'data-src', element.getAttribute( 'src' ) );
element.removeAttribute( 'src' );
} );
// Reset lazy-loaded media elements with <source> children
2020-03-06 16:40:11 +00:00
toArray( slide.querySelectorAll( 'video[data-lazy-loaded] source[src], audio source[src]' ) ).forEach( source => {
source.setAttribute( 'data-src', source.getAttribute( 'src' ) );
source.removeAttribute( 'src' );
} );
}
/**
2011-12-05 02:55:48 +00:00
* Determine what available routes there are for navigation.
*
2016-06-30 03:10:55 +00:00
* @return {{left: boolean, right: boolean, up: boolean, down: boolean}}
*/
function availableRoutes() {
2020-03-07 10:58:18 +00:00
let horizontalSlides = dom.wrapper.querySelectorAll( HORIZONTAL_SLIDES_SELECTOR ),
verticalSlides = dom.wrapper.querySelectorAll( VERTICAL_SLIDES_SELECTOR );
2020-03-06 16:40:11 +00:00
let routes = {
left: indexh > 0,
right: indexh < horizontalSlides.length - 1,
up: indexv > 0,
down: indexv < verticalSlides.length - 1
};
// Looped presentations can always be navigated as long as
// there are slides available
if( config.loop ) {
if( horizontalSlides.length > 1 ) {
routes.left = true;
routes.right = true;
}
if( verticalSlides.length > 1 ) {
routes.up = true;
routes.down = true;
}
}
// Reverse horizontal controls for rtl
if( config.rtl ) {
2020-03-06 16:40:11 +00:00
let left = routes.left;
routes.left = routes.right;
routes.right = left;
}
return routes;
}
/**
* Returns an object describing the available fragment
* directions.
*
2016-06-30 03:10:55 +00:00
* @return {{prev: boolean, next: boolean}}
*/
function availableFragments() {
if( currentSlide && config.fragments ) {
2020-03-06 16:40:11 +00:00
let fragments = currentSlide.querySelectorAll( '.fragment' );
let hiddenFragments = currentSlide.querySelectorAll( '.fragment:not(.visible)' );
return {
prev: fragments.length - hiddenFragments.length > 0,
next: !!hiddenFragments.length
};
}
else {
return { prev: false, next: false };
}
}
/**
2014-06-12 16:20:15 +00:00
* Enforces origin-specific format rules for embedded media.
*/
function formatEmbeddedContent() {
2020-03-06 16:40:11 +00:00
let _appendParamToIframeSource = ( sourceAttribute, sourceURL, param ) => {
toArray( dom.slides.querySelectorAll( 'iframe['+ sourceAttribute +'*="'+ sourceURL +'"]' ) ).forEach( el => {
2020-03-07 10:58:18 +00:00
let src = el.getAttribute( sourceAttribute );
if( src && src.indexOf( param ) === -1 ) {
el.setAttribute( sourceAttribute, src + ( !/\?/.test( src ) ? '?' : '&' ) + param );
}
});
};
// YouTube frames must include "?enablejsapi=1"
_appendParamToIframeSource( 'src', 'youtube.com/embed/', 'enablejsapi=1' );
_appendParamToIframeSource( 'data-src', 'youtube.com/embed/', 'enablejsapi=1' );
2014-06-12 16:20:15 +00:00
// Vimeo frames must include "?api=1"
_appendParamToIframeSource( 'src', 'player.vimeo.com/', 'api=1' );
_appendParamToIframeSource( 'data-src', 'player.vimeo.com/', 'api=1' );
2014-06-12 16:20:15 +00:00
}
/**
* Start playback of any embedded content inside of
* the given element.
2016-06-30 03:10:55 +00:00
*
* @param {HTMLElement} element
*/
function startEmbeddedContent( element ) {
if( element && !isSpeakerNotes() ) {
// Restart GIFs
2020-03-06 16:40:11 +00:00
toArray( element.querySelectorAll( 'img[src$=".gif"]' ) ).forEach( el => {
// Setting the same unchanged source like this was confirmed
// to work in Chrome, FF & Safari
el.setAttribute( 'src', el.getAttribute( 'src' ) );
} );
// HTML5 media elements
2020-03-06 16:40:11 +00:00
toArray( element.querySelectorAll( 'video, audio' ) ).forEach( el => {
if( closestParent( el, '.fragment' ) && !closestParent( el, '.fragment.visible' ) ) {
return;
}
// Prefer an explicit global autoplay setting
2020-03-06 16:40:11 +00:00
let autoplay = config.autoPlayMedia;
// If no global setting is available, fall back on the element's
// own autoplay setting
if( typeof autoplay !== 'boolean' ) {
autoplay = el.hasAttribute( 'data-autoplay' ) || !!closestParent( el, '.slide-background' );
}
if( autoplay && typeof el.play === 'function' ) {
2017-02-14 13:51:14 +00:00
2018-03-05 13:59:32 +00:00
// If the media is ready, start playback
if( el.readyState > 1 ) {
startEmbeddedMedia( { target: el } );
}
2018-03-05 13:59:32 +00:00
// Mobile devices never fire a loaded event so instead
// of waiting, we initiate playback
else if( isMobileDevice ) {
2020-03-06 16:40:11 +00:00
let promise = el.play();
// If autoplay does not work, ensure that the controls are visible so
// that the viewer can start the media on their own
if( promise && typeof promise.catch === 'function' && el.controls === false ) {
2020-03-07 10:58:18 +00:00
promise.catch( () => {
el.controls = true;
// Once the video does start playing, hide the controls again
2020-03-06 16:40:11 +00:00
el.addEventListener( 'play', () => {
el.controls = false;
} );
} );
}
2018-03-05 13:59:32 +00:00
}
// If the media isn't loaded, wait before playing
else {
el.removeEventListener( 'loadeddata', startEmbeddedMedia ); // remove first to avoid dupes
el.addEventListener( 'loadeddata', startEmbeddedMedia );
}
}
} );
// Normal iframes
2020-03-06 16:40:11 +00:00
toArray( element.querySelectorAll( 'iframe[src]' ) ).forEach( el => {
if( closestParent( el, '.fragment' ) && !closestParent( el, '.fragment.visible' ) ) {
return;
}
startEmbeddedIframe( { target: el } );
} );
// Lazy loading iframes
2020-03-06 16:40:11 +00:00
toArray( element.querySelectorAll( 'iframe[data-src]' ) ).forEach( el => {
if( closestParent( el, '.fragment' ) && !closestParent( el, '.fragment.visible' ) ) {
return;
}
if( el.getAttribute( 'src' ) !== el.getAttribute( 'data-src' ) ) {
el.removeEventListener( 'load', startEmbeddedIframe ); // remove first to avoid dupes
el.addEventListener( 'load', startEmbeddedIframe );
el.setAttribute( 'src', el.getAttribute( 'data-src' ) );
}
} );
}
}
/**
* Starts playing an embedded video/audio element after
* it has finished loading.
*
* @param {object} event
*/
function startEmbeddedMedia( event ) {
2020-03-06 16:40:11 +00:00
let isAttachedToDOM = !!closestParent( event.target, 'html' ),
isVisible = !!closestParent( event.target, '.present' );
if( isAttachedToDOM && isVisible ) {
event.target.currentTime = 0;
event.target.play();
}
event.target.removeEventListener( 'loadeddata', startEmbeddedMedia );
}
/**
* "Starts" the content of an embedded iframe using the
2016-06-30 03:10:55 +00:00
* postMessage API.
*
* @param {object} event
*/
function startEmbeddedIframe( event ) {
2014-06-12 16:20:15 +00:00
2020-03-06 16:40:11 +00:00
let iframe = event.target;
2016-07-04 11:32:03 +00:00
if( iframe && iframe.contentWindow ) {
2020-03-06 16:40:11 +00:00
let isAttachedToDOM = !!closestParent( event.target, 'html' ),
isVisible = !!closestParent( event.target, '.present' );
if( isAttachedToDOM && isVisible ) {
// Prefer an explicit global autoplay setting
2020-03-06 16:40:11 +00:00
let autoplay = config.autoPlayMedia;
// If no global setting is available, fall back on the element's
// own autoplay setting
if( typeof autoplay !== 'boolean' ) {
autoplay = iframe.hasAttribute( 'data-autoplay' ) || !!closestParent( iframe, '.slide-background' );
}
// YouTube postMessage API
if( /youtube\.com\/embed\//.test( iframe.getAttribute( 'src' ) ) && autoplay ) {
iframe.contentWindow.postMessage( '{"event":"command","func":"playVideo","args":""}', '*' );
}
// Vimeo postMessage API
else if( /player\.vimeo\.com\//.test( iframe.getAttribute( 'src' ) ) && autoplay ) {
iframe.contentWindow.postMessage( '{"method":"play"}', '*' );
}
// Generic postMessage API
else {
iframe.contentWindow.postMessage( 'slide:start', '*' );
}
2016-07-04 11:32:03 +00:00
}
}
}
/**
* Stop playback of any embedded content inside of
* the targeted slide.
2016-06-30 03:10:55 +00:00
*
* @param {HTMLElement} element
*/
2020-03-06 16:40:11 +00:00
function stopEmbeddedContent( element, options = {} ) {
options = extend( {
// Defaults
unloadIframes: true
2020-03-06 16:40:11 +00:00
}, options );
if( element && element.parentNode ) {
// HTML5 media elements
2020-03-06 16:40:11 +00:00
toArray( element.querySelectorAll( 'video, audio' ) ).forEach( el => {
if( !el.hasAttribute( 'data-ignore' ) && typeof el.pause === 'function' ) {
el.setAttribute('data-paused-by-reveal', '');
el.pause();
}
} );
// Generic postMessage API for non-lazy loaded iframes
2020-03-06 16:40:11 +00:00
toArray( element.querySelectorAll( 'iframe' ) ).forEach( el => {
2017-03-14 08:06:39 +00:00
if( el.contentWindow ) el.contentWindow.postMessage( 'slide:stop', '*' );
el.removeEventListener( 'load', startEmbeddedIframe );
});
// YouTube postMessage API
2020-03-06 16:40:11 +00:00
toArray( element.querySelectorAll( 'iframe[src*="youtube.com/embed/"]' ) ).forEach( el => {
2017-03-14 08:06:39 +00:00
if( !el.hasAttribute( 'data-ignore' ) && el.contentWindow && typeof el.contentWindow.postMessage === 'function' ) {
2013-10-27 19:27:35 +00:00
el.contentWindow.postMessage( '{"event":"command","func":"pauseVideo","args":""}', '*' );
}
});
2014-06-12 16:20:15 +00:00
// Vimeo postMessage API
2020-03-06 16:40:11 +00:00
toArray( element.querySelectorAll( 'iframe[src*="player.vimeo.com/"]' ) ).forEach( el => {
2017-03-14 08:06:39 +00:00
if( !el.hasAttribute( 'data-ignore' ) && el.contentWindow && typeof el.contentWindow.postMessage === 'function' ) {
2014-06-12 16:20:15 +00:00
el.contentWindow.postMessage( '{"method":"pause"}', '*' );
}
});
if( options.unloadIframes === true ) {
// Unload lazy-loaded iframes
2020-03-06 16:40:11 +00:00
toArray( element.querySelectorAll( 'iframe[data-src]' ) ).forEach( el => {
// Only removing the src doesn't actually unload the frame
// in all browsers (Firefox) so we set it to blank first
el.setAttribute( 'src', 'about:blank' );
el.removeAttribute( 'src' );
} );
}
}
}
2014-03-12 21:26:31 +00:00
/**
* Returns the number of past slides. This can be used as a global
* flattened index for slides.
2016-06-30 03:10:55 +00:00
*
* @param {HTMLElement} [slide=currentSlide] The slide we're counting before
*
2016-06-30 03:10:55 +00:00
* @return {number} Past slide count
2014-03-12 21:26:31 +00:00
*/
2020-03-06 16:40:11 +00:00
function getSlidePastCount( slide = currentSlide ) {
2020-03-06 16:40:11 +00:00
let horizontalSlides = getHorizontalSlides();
2014-03-12 21:26:31 +00:00
// The number of past slides
2020-03-06 16:40:11 +00:00
let pastCount = 0;
2014-03-12 21:26:31 +00:00
// Step through all slides and count the past ones
2020-03-06 16:40:11 +00:00
mainLoop: for( let i = 0; i < horizontalSlides.length; i++ ) {
2014-03-12 21:26:31 +00:00
2020-03-06 16:40:11 +00:00
let horizontalSlide = horizontalSlides[i];
let verticalSlides = horizontalSlide.querySelectorAll( 'section' );
2014-03-12 21:26:31 +00:00
2020-03-06 16:40:11 +00:00
for( let j = 0; j < verticalSlides.length; j++ ) {
2014-03-12 21:26:31 +00:00
// Stop as soon as we arrive at the present
if( verticalSlides[j] === slide ) {
2014-03-12 21:26:31 +00:00
break mainLoop;
}
// Don't count slides with the "uncounted" class
if( verticalSlides[j].dataset.visibility !== 'uncounted' ) {
pastCount++;
}
2014-03-12 21:26:31 +00:00
}
// Stop as soon as we arrive at the present
if( horizontalSlide === slide ) {
2014-03-12 21:26:31 +00:00
break;
}
// Don't count the wrapping section for vertical slides and
// slides marked as uncounted
if( horizontalSlide.classList.contains( 'stack' ) === false && !horizontalSlide.dataset.visibility !== 'uncounted' ) {
2014-03-12 21:26:31 +00:00
pastCount++;
}
}
return pastCount;
}
/**
* Returns a value ranging from 0-1 that represents
* how far into the presentation we have navigated.
2016-06-30 03:10:55 +00:00
*
* @return {number}
*/
function getProgress() {
// The number of past and total slides
2020-03-06 16:40:11 +00:00
let totalCount = getTotalSlides();
let pastCount = getSlidePastCount();
if( currentSlide ) {
2020-03-06 16:40:11 +00:00
let allFragments = currentSlide.querySelectorAll( '.fragment' );
// If there are fragments in the current slide those should be
// accounted for in the progress.
if( allFragments.length > 0 ) {
2020-03-06 16:40:11 +00:00
let visibleFragments = currentSlide.querySelectorAll( '.fragment.visible' );
// This value represents how big a portion of the slide progress
// that is made up by its fragments (0-1)
2020-03-06 16:40:11 +00:00
let fragmentWeight = 0.9;
// Add fragment progress to the past slide count
pastCount += ( visibleFragments.length / allFragments.length ) * fragmentWeight;
}
}
return Math.min( pastCount / ( totalCount - 1 ), 1 );
2014-03-12 21:26:31 +00:00
}
/**
* Checks if this presentation is running inside of the
* speaker notes window.
2016-06-30 03:10:55 +00:00
*
* @return {boolean}
*/
function isSpeakerNotes() {
return !!window.location.search.match( /receiver/gi );
}
2011-06-07 19:10:59 +00:00
/**
* Reads the current URL (hash) and navigates accordingly.
*/
function readURL() {
2020-03-06 16:40:11 +00:00
let hash = window.location.hash;
2012-08-21 02:13:00 +00:00
// Attempt to parse the hash as either an index or name
2020-03-06 16:40:11 +00:00
let bits = hash.slice( 2 ).split( '/' ),
2012-08-21 02:13:00 +00:00
name = hash.replace( /#|\//gi, '' );
// If the first bit is not fully numeric and there is a name we
// can assume that this is a named link
if( !/^[0-9]*$/.test( bits[0] ) && name.length ) {
2020-03-06 16:40:11 +00:00
let element;
// Ensure the named link is a valid HTML ID attribute
2017-11-17 10:59:21 +00:00
try {
element = document.getElementById( decodeURIComponent( name ) );
}
2018-03-22 10:58:15 +00:00
catch ( error ) { }
2012-08-21 02:13:00 +00:00
2018-03-27 12:21:41 +00:00
// Ensure that we're not already on a slide with the same name
2020-03-06 16:40:11 +00:00
let isSameNameAsCurrentSlide = currentSlide ? currentSlide.getAttribute( 'id' ) === name : false;
2012-08-21 02:13:00 +00:00
if( element ) {
// If the slide exists and is not the current slide...
if ( !isSameNameAsCurrentSlide ) {
// ...find the position of the named slide and navigate to it
2020-03-06 16:40:11 +00:00
let indices = Reveal.getIndices(element);
slide(indices.h, indices.v);
}
2012-08-21 02:13:00 +00:00
}
// If the slide doesn't exist, navigate to the current slide
else {
slide( indexh || 0, indexv || 0 );
2012-08-21 02:13:00 +00:00
}
}
else {
2020-03-06 16:40:11 +00:00
let hashIndexBase = config.hashOneBasedIndex ? 1 : 0;
2012-08-21 02:13:00 +00:00
// Read the index components of the hash
2020-03-06 16:40:11 +00:00
let h = ( parseInt( bits[0], 10 ) - hashIndexBase ) || 0,
v = ( parseInt( bits[1], 10 ) - hashIndexBase ) || 0,
2018-01-04 20:09:01 +00:00
f;
2018-01-04 20:09:01 +00:00
if( config.fragmentInURL ) {
f = parseInt( bits[2], 10 );
if( isNaN( f ) ) {
f = undefined;
}
2018-01-04 20:09:01 +00:00
}
2018-01-04 20:09:01 +00:00
if( h !== indexh || v !== indexv || f !== undefined ) {
slide( h, v, f );
}
2012-08-21 02:13:00 +00:00
}
2011-06-07 19:10:59 +00:00
}
2011-06-07 19:10:59 +00:00
/**
* Updates the page URL (hash) to reflect the current
* state.
*
2016-06-30 03:10:55 +00:00
* @param {number} delay The time in ms to wait before
* writing the hash
2011-06-07 19:10:59 +00:00
*/
function writeURL( delay ) {
// Make sure there's never more than one timeout running
clearTimeout( writeURLTimeout );
// If a delay is specified, timeout this call
if( typeof delay === 'number' ) {
writeURLTimeout = setTimeout( writeURL, delay );
}
else if( currentSlide ) {
2019-03-21 08:13:28 +00:00
// If we're configured to push to history OR the history
// API is not avaialble.
if( config.history || !window.history ) {
window.location.hash = locationHash();
}
2019-04-01 11:11:29 +00:00
// If we're configured to reflect the current slide in the
2019-03-21 08:13:28 +00:00
// URL without pushing to history.
else if( config.hash ) {
2019-03-21 08:13:28 +00:00
window.history.replaceState( null, null, '#' + locationHash() );
}
// If history and hash are both disabled, a hash may still
// be added to the URL by clicking on a href with a hash
// target. Counter this by always removing the hash.
else {
window.history.replaceState( null, null, window.location.pathname + window.location.search );
}
}
2011-06-07 19:10:59 +00:00
}
/**
2016-06-30 03:10:55 +00:00
* Retrieves the h/v location and fragment of the current,
* or specified, slide.
*
2016-06-30 03:10:55 +00:00
* @param {HTMLElement} [slide] If specified, the returned
* index will be for this slide rather than the currently
* active one
*
2016-06-30 03:10:55 +00:00
* @return {{h: number, v: number, f: number}}
*/
function getIndices( slide ) {
// By default, return the current indices
2020-03-06 16:40:11 +00:00
let h = indexh,
v = indexv,
f;
// If a slide is specified, return the indices of that slide
if( slide ) {
2020-03-06 16:40:11 +00:00
let isVertical = isVerticalSlide( slide );
let slideh = isVertical ? slide.parentNode : slide;
// Select all horizontal slides
2020-03-06 16:40:11 +00:00
let horizontalSlides = toArray( dom.wrapper.querySelectorAll( HORIZONTAL_SLIDES_SELECTOR ) );
// Now that we know which the horizontal slide is, get its index
h = Math.max( horizontalSlides.indexOf( slideh ), 0 );
2014-04-27 13:39:11 +00:00
// Assume we're not vertical
v = undefined;
2014-04-27 13:39:11 +00:00
// If this is a vertical slide, grab the vertical index
if( isVertical ) {
v = Math.max( toArray( slide.parentNode.querySelectorAll( 'section' ) ).indexOf( slide ), 0 );
}
}
if( !slide && currentSlide ) {
2020-03-06 16:40:11 +00:00
let hasFragments = currentSlide.querySelectorAll( '.fragment' ).length > 0;
if( hasFragments ) {
2020-03-06 16:40:11 +00:00
let currentFragment = currentSlide.querySelector( '.current-fragment' );
if( currentFragment && currentFragment.hasAttribute( 'data-fragment-index' ) ) {
f = parseInt( currentFragment.getAttribute( 'data-fragment-index' ), 10 );
}
else {
f = currentSlide.querySelectorAll( '.fragment.visible' ).length - 1;
}
}
}
2020-03-06 16:40:11 +00:00
return { h, v, f };
}
/**
* Retrieves all slides in this presentation.
*/
function getSlides() {
return toArray( dom.wrapper.querySelectorAll( SLIDES_SELECTOR + ':not(.stack):not([data-visibility="uncounted"])' ) );
}
/**
* Returns a list of all horizontal slides in the deck. Each
* vertical stack is included as one horizontal slide in the
* resulting array.
*/
function getHorizontalSlides() {
return toArray( dom.wrapper.querySelectorAll( HORIZONTAL_SLIDES_SELECTOR ) );
}
/**
* Returns all vertical slides that exist within this deck.
*/
function getVerticalSlides() {
return toArray( dom.wrapper.querySelectorAll( '.slides>section>section' ) );
}
2020-03-06 13:54:55 +00:00
/**
* Returns all vertical stacks (each stack can contain multiple slides).
*/
function getVerticalStacks() {
return toArray( dom.wrapper.querySelectorAll( HORIZONTAL_SLIDES_SELECTOR + '.stack') );
}
/**
* Returns true if there are at least two horizontal slides.
*/
function hasHorizontalSlides() {
return getHorizontalSlides().length > 1;
}
/**
* Returns true if there are at least two vertical slides.
*/
function hasVerticalSlides() {
return getVerticalSlides().length > 1;
}
2018-02-20 09:30:56 +00:00
/**
2018-10-04 11:26:16 +00:00
* Returns an array of objects where each object represents the
* attributes on its respective slide.
2018-02-20 09:30:56 +00:00
*/
2018-10-04 11:26:16 +00:00
function getSlidesAttributes() {
2020-03-07 10:58:18 +00:00
return getSlides().map( slide => {
2018-10-04 11:26:16 +00:00
2020-03-06 16:40:11 +00:00
let attributes = {};
for( let i = 0; i < slide.attributes.length; i++ ) {
let attribute = slide.attributes[ i ];
2018-10-04 11:26:16 +00:00
attributes[ attribute.name ] = attribute.value;
}
2018-10-04 11:26:16 +00:00
return attributes;
} );
}
2014-04-01 07:12:41 +00:00
/**
* Retrieves the total number of slides in this presentation.
2016-06-30 03:10:55 +00:00
*
* @return {number}
2014-04-01 07:12:41 +00:00
*/
function getTotalSlides() {
return getSlides().length;
2014-04-01 07:12:41 +00:00
}
/**
* Returns the slide element matching the specified index.
2016-06-30 03:10:55 +00:00
*
* @return {HTMLElement}
*/
2014-04-27 12:46:49 +00:00
function getSlide( x, y ) {
2020-03-06 16:40:11 +00:00
let horizontalSlide = getHorizontalSlides()[ x ];
let verticalSlides = horizontalSlide && horizontalSlide.querySelectorAll( 'section' );
2014-04-27 12:46:49 +00:00
if( verticalSlides && verticalSlides.length && typeof y === 'number' ) {
2014-04-27 12:46:49 +00:00
return verticalSlides ? verticalSlides[ y ] : undefined;
}
return horizontalSlide;
}
/**
* Returns the background element for the given slide.
* All slides, even the ones with no background properties
* defined, have a background element so as long as the
* index is valid an element will be returned.
2016-06-30 03:10:55 +00:00
*
* @param {mixed} x Horizontal background index OR a slide
* HTML element
2016-06-30 03:10:55 +00:00
* @param {number} y Vertical background index
* @return {(HTMLElement[]|*)}
2014-04-27 12:46:49 +00:00
*/
function getSlideBackground( x, y ) {
2020-03-06 16:40:11 +00:00
let slide = typeof x === 'number' ? getSlide( x, y ) : x;
if( slide ) {
return slide.slideBackgroundElement;
2014-04-27 12:46:49 +00:00
}
return undefined;
2014-04-27 12:46:49 +00:00
}
2015-09-10 06:28:52 +00:00
/**
* Retrieves the speaker notes from a slide. Notes can be
* defined in two ways:
* 1. As a data-notes attribute on the slide <section>
* 2. As an <aside class="notes"> inside of the slide
2016-06-30 03:10:55 +00:00
*
* @param {HTMLElement} [slide=currentSlide]
* @return {(string|null)}
2015-09-10 06:28:52 +00:00
*/
2020-03-06 16:40:11 +00:00
function getSlideNotes( slide = currentSlide ) {
2015-09-10 06:28:52 +00:00
// Notes can be specified via the data-notes attribute...
if( slide.hasAttribute( 'data-notes' ) ) {
return slide.getAttribute( 'data-notes' );
}
// ... or using an <aside class="notes"> element
2020-03-06 16:40:11 +00:00
let notesElement = slide.querySelector( 'aside.notes' );
2015-09-10 06:28:52 +00:00
if( notesElement ) {
return notesElement.innerHTML;
}
return null;
}
/**
* Retrieves the current state of the presentation as
* an object. This state can then be restored at any
* time.
2016-06-30 03:10:55 +00:00
*
* @return {{indexh: number, indexv: number, indexf: number, paused: boolean, overview: boolean}}
*/
function getState() {
2020-03-06 16:40:11 +00:00
let indices = getIndices();
return {
indexh: indices.h,
indexv: indices.v,
indexf: indices.f,
paused: isPaused(),
overview: isOverview()
};
}
/**
* Restores the presentation to the given state.
*
2016-06-30 03:10:55 +00:00
* @param {object} state As generated by getState()
* @see {@link getState} generates the parameter `state`
*/
function setState( state ) {
if( typeof state === 'object' ) {
2014-03-12 07:51:51 +00:00
slide( deserialize( state.indexh ), deserialize( state.indexv ), deserialize( state.indexf ) );
2020-03-07 10:58:18 +00:00
let pausedFlag = deserialize( state.paused ),
overviewFlag = deserialize( state.overview );
if( typeof pausedFlag === 'boolean' && pausedFlag !== isPaused() ) {
togglePause( pausedFlag );
}
if( typeof overviewFlag === 'boolean' && overviewFlag !== isOverview() ) {
toggleOverview( overviewFlag );
}
}
}
2013-11-25 20:40:24 +00:00
/**
* Return a sorted fragments list, ordered by an increasing
* "data-fragment-index" attribute.
*
* Fragments will be revealed in the order that they are returned by
* this function, so you can use the index attributes to control the
* order of fragment appearance.
*
* To maintain a sensible default fragment order, fragments are presumed
* to be passed in document order. This function adds a "fragment-index"
* attribute to each node if such an attribute is not already present,
* and sets that attribute to an integer value which is the position of
* the fragment within the fragments list.
2016-06-30 03:10:55 +00:00
*
* @param {object[]|*} fragments
* @param {boolean} grouped If true the returned array will contain
* nested arrays for all fragments with the same index
2016-06-30 03:10:55 +00:00
* @return {object[]} sorted Sorted array of fragments
2013-11-25 20:40:24 +00:00
*/
2020-03-06 16:40:11 +00:00
function sortFragments( fragments, grouped = false ) {
2013-11-25 20:40:24 +00:00
fragments = toArray( fragments );
2020-03-06 16:40:11 +00:00
let ordered = [],
2013-11-25 20:40:24 +00:00
unordered = [],
sorted = [];
// Group ordered and unordered elements
2020-03-06 16:40:11 +00:00
fragments.forEach( fragment => {
2013-11-25 20:40:24 +00:00
if( fragment.hasAttribute( 'data-fragment-index' ) ) {
2020-03-06 16:40:11 +00:00
let index = parseInt( fragment.getAttribute( 'data-fragment-index' ), 10 );
2013-11-25 20:40:24 +00:00
if( !ordered[index] ) {
ordered[index] = [];
}
ordered[index].push( fragment );
}
else {
unordered.push( [ fragment ] );
}
} );
// Append fragments without explicit indices in their
// DOM order
ordered = ordered.concat( unordered );
// Manually count the index up per group to ensure there
// are no gaps
2020-03-06 16:40:11 +00:00
let index = 0;
2013-11-25 20:40:24 +00:00
// Push all fragments in their sorted order to an array,
// this flattens the groups
2020-03-06 16:40:11 +00:00
ordered.forEach( group => {
group.forEach( fragment => {
2013-11-25 20:40:24 +00:00
sorted.push( fragment );
fragment.setAttribute( 'data-fragment-index', index );
} );
index ++;
} );
return grouped === true ? ordered : sorted;
2013-11-25 20:40:24 +00:00
}
2018-10-11 09:24:54 +00:00
/**
* Refreshes the fragments on the current slide so that they
* have the appropriate classes (.visible + .current-fragment).
*
* @param {number} [index] The index of the current fragment
* @param {array} [fragments] Array containing all fragments
* in the current slide
*
* @return {{shown: array, hidden: array}}
*/
function updateFragments( index, fragments ) {
2020-03-06 16:40:11 +00:00
let changedFragments = {
2018-10-11 09:24:54 +00:00
shown: [],
hidden: []
};
if( currentSlide && config.fragments ) {
fragments = fragments || sortFragments( currentSlide.querySelectorAll( '.fragment' ) );
if( fragments.length ) {
2020-03-06 16:40:11 +00:00
let maxIndex = 0;
2018-10-11 09:24:54 +00:00
if( typeof index !== 'number' ) {
2020-03-06 16:40:11 +00:00
let currentFragment = sortFragments( currentSlide.querySelectorAll( '.fragment.visible' ) ).pop();
2018-10-11 09:24:54 +00:00
if( currentFragment ) {
index = parseInt( currentFragment.getAttribute( 'data-fragment-index' ) || 0, 10 );
}
}
2020-03-06 16:40:11 +00:00
toArray( fragments ).forEach( ( el, i ) => {
2018-10-11 09:24:54 +00:00
if( el.hasAttribute( 'data-fragment-index' ) ) {
i = parseInt( el.getAttribute( 'data-fragment-index' ), 10 );
}
maxIndex = Math.max( maxIndex, i );
2018-10-11 09:24:54 +00:00
// Visible fragments
if( i <= index ) {
if( !el.classList.contains( 'visible' ) ) changedFragments.shown.push( el );
el.classList.add( 'visible' );
el.classList.remove( 'current-fragment' );
// Announce the fragments one by one to the Screen Reader
dom.statusDiv.textContent = getStatusText( el );
if( i === index ) {
el.classList.add( 'current-fragment' );
startEmbeddedContent( el );
}
}
// Hidden fragments
else {
if( el.classList.contains( 'visible' ) ) changedFragments.hidden.push( el );
el.classList.remove( 'visible' );
el.classList.remove( 'current-fragment' );
}
} );
// Write the current fragment index to the slide <section>.
// This can be used by end users to apply styles based on
// the current fragment index.
index = typeof index === 'number' ? index : -1;
index = Math.max( Math.min( index, maxIndex ), -1 );
currentSlide.setAttribute( 'data-fragment', index );
2018-10-11 09:24:54 +00:00
}
}
return changedFragments;
}
/**
2013-11-18 14:01:33 +00:00
* Navigate to the specified slide fragment.
*
2016-06-30 03:10:55 +00:00
* @param {?number} index The index of the fragment that
2013-11-21 14:01:18 +00:00
* should be shown, -1 means all are invisible
2016-06-30 03:10:55 +00:00
* @param {number} offset Integer offset to apply to the
2013-11-18 14:14:01 +00:00
* fragment index
*
2016-06-30 03:10:55 +00:00
* @return {boolean} true if a change was made in any
2013-11-18 14:14:01 +00:00
* fragments visibility as part of this call
*/
2020-03-06 16:40:11 +00:00
function navigateFragment( index, offset = 0 ) {
if( currentSlide && config.fragments ) {
2020-03-06 16:40:11 +00:00
let fragments = sortFragments( currentSlide.querySelectorAll( '.fragment' ) );
if( fragments.length ) {
2013-11-18 14:14:01 +00:00
// If no index is specified, find the current
2013-11-18 14:01:33 +00:00
if( typeof index !== 'number' ) {
2020-03-06 16:40:11 +00:00
let lastVisibleFragment = sortFragments( currentSlide.querySelectorAll( '.fragment.visible' ) ).pop();
2013-11-18 14:01:33 +00:00
if( lastVisibleFragment ) {
2013-11-21 14:01:18 +00:00
index = parseInt( lastVisibleFragment.getAttribute( 'data-fragment-index' ) || 0, 10 );
2013-11-18 14:01:33 +00:00
}
else {
2013-11-21 14:01:18 +00:00
index = -1;
2013-11-18 14:01:33 +00:00
}
}
2020-03-06 16:40:11 +00:00
// Apply the offset if there is one
index += offset;
2013-11-18 14:01:33 +00:00
2020-03-06 16:40:11 +00:00
let changedFragments = updateFragments( index, fragments );
2013-11-18 14:01:33 +00:00
2018-10-11 09:24:54 +00:00
if( changedFragments.hidden.length ) {
dispatchEvent( 'fragmenthidden', { fragment: changedFragments.hidden[0], fragments: changedFragments.hidden } );
2013-11-18 14:01:33 +00:00
}
2018-10-11 09:24:54 +00:00
if( changedFragments.shown.length ) {
dispatchEvent( 'fragmentshown', { fragment: changedFragments.shown[0], fragments: changedFragments.shown } );
2013-11-18 14:01:33 +00:00
}
updateControls();
updateProgress();
2018-10-11 09:24:54 +00:00
2018-01-04 20:09:01 +00:00
if( config.fragmentInURL ) {
writeURL();
}
2013-11-18 14:01:33 +00:00
2018-10-11 09:24:54 +00:00
return !!( changedFragments.shown.length || changedFragments.hidden.length );
2013-11-18 14:01:33 +00:00
}
2013-11-18 14:01:33 +00:00
}
return false;
}
/**
2013-11-18 14:01:33 +00:00
* Navigate to the next slide fragment.
*
2016-06-30 03:10:55 +00:00
* @return {boolean} true if there was a next fragment,
* false otherwise
*/
2013-11-18 14:01:33 +00:00
function nextFragment() {
2013-11-18 14:01:33 +00:00
return navigateFragment( null, 1 );
2013-11-18 14:01:33 +00:00
}
2013-11-18 14:01:33 +00:00
/**
* Navigate to the previous slide fragment.
*
2016-06-30 03:10:55 +00:00
* @return {boolean} true if there was a previous fragment,
2013-11-18 14:01:33 +00:00
* false otherwise
*/
2020-03-06 16:50:15 +00:00
function prevFragment() {
2013-11-18 14:01:33 +00:00
return navigateFragment( null, -1 );
}
/**
* Cues a new automated slide if enabled in the config.
*/
function cueAutoSlide() {
cancelAutoSlide();
if( currentSlide && config.autoSlide !== false ) {
2020-03-06 16:40:11 +00:00
let fragment = currentSlide.querySelector( '.current-fragment' );
// When the slide first appears there is no "current" fragment so
// we look for a data-autoslide timing on the first fragment
if( !fragment ) fragment = currentSlide.querySelector( '.fragment' );
2020-03-06 16:40:11 +00:00
let fragmentAutoSlide = fragment ? fragment.getAttribute( 'data-autoslide' ) : null;
let parentAutoSlide = currentSlide.parentNode ? currentSlide.parentNode.getAttribute( 'data-autoslide' ) : null;
let slideAutoSlide = currentSlide.getAttribute( 'data-autoslide' );
2013-11-07 14:15:56 +00:00
// Pick value in the following priority order:
// 1. Current fragment's data-autoslide
// 2. Current slide's data-autoslide
// 3. Parent slide's data-autoslide
// 4. Global autoSlide setting
if( fragmentAutoSlide ) {
autoSlide = parseInt( fragmentAutoSlide, 10 );
}
else if( slideAutoSlide ) {
autoSlide = parseInt( slideAutoSlide, 10 );
}
else if( parentAutoSlide ) {
autoSlide = parseInt( parentAutoSlide, 10 );
}
else {
autoSlide = config.autoSlide;
}
// If there are media elements with data-autoplay,
// automatically set the autoSlide duration to the
2015-03-25 14:48:10 +00:00
// length of that media. Not applicable if the slide
// is divided up into fragments.
// playbackRate is accounted for in the duration.
2015-03-25 14:48:10 +00:00
if( currentSlide.querySelectorAll( '.fragment' ).length === 0 ) {
2020-03-06 16:40:11 +00:00
toArray( currentSlide.querySelectorAll( 'video, audio' ) ).forEach( el => {
2015-03-25 14:48:10 +00:00
if( el.hasAttribute( 'data-autoplay' ) ) {
if( autoSlide && (el.duration * 1000 / el.playbackRate ) > autoSlide ) {
autoSlide = ( el.duration * 1000 / el.playbackRate ) + 1000;
2015-03-25 14:48:10 +00:00
}
}
2015-03-25 14:48:10 +00:00
} );
}
// Cue the next auto-slide if:
// - There is an autoSlide value
// - Auto-sliding isn't paused by the user
// - The presentation isn't paused
// - The overview isn't active
// - The presentation isn't over
if( autoSlide && !autoSlidePaused && !isPaused() && !isOverview() && ( !Reveal.isLastSlide() || availableFragments().next || config.loop === true ) ) {
2020-03-06 16:40:11 +00:00
autoSlideTimeout = setTimeout( () => {
if( typeof config.autoSlideMethod === 'function' ) {
config.autoSlideMethod()
}
else {
navigateNext();
}
cueAutoSlide();
}, autoSlide );
autoSlideStartTime = Date.now();
}
if( autoSlidePlayer ) {
autoSlidePlayer.setPlaying( autoSlideTimeout !== -1 );
}
}
}
/**
* Cancels any ongoing request to auto-slide.
*/
function cancelAutoSlide() {
clearTimeout( autoSlideTimeout );
autoSlideTimeout = -1;
}
function pauseAutoSlide() {
if( autoSlide && !autoSlidePaused ) {
autoSlidePaused = true;
dispatchEvent( 'autoslidepaused' );
clearTimeout( autoSlideTimeout );
if( autoSlidePlayer ) {
autoSlidePlayer.setPlaying( false );
}
}
}
function resumeAutoSlide() {
if( autoSlide && autoSlidePaused ) {
autoSlidePaused = false;
dispatchEvent( 'autoslideresumed' );
cueAutoSlide();
}
}
2011-06-07 19:10:59 +00:00
function navigateLeft() {
2020-02-06 14:19:09 +00:00
hasNavigatedHorizontally = true;
// Reverse for RTL
if( config.rtl ) {
if( ( isOverview() || nextFragment() === false ) && availableRoutes().left ) {
slide( indexh + 1, config.navigationMode === 'grid' ? indexv : undefined );
}
}
// Normal navigation
2020-03-06 16:50:15 +00:00
else if( ( isOverview() || prevFragment() === false ) && availableRoutes().left ) {
slide( indexh - 1, config.navigationMode === 'grid' ? indexv : undefined );
}
2011-06-07 19:10:59 +00:00
}
2011-06-07 19:10:59 +00:00
function navigateRight() {
2020-02-06 14:19:09 +00:00
hasNavigatedHorizontally = true;
// Reverse for RTL
if( config.rtl ) {
2020-03-06 16:50:15 +00:00
if( ( isOverview() || prevFragment() === false ) && availableRoutes().right ) {
slide( indexh - 1, config.navigationMode === 'grid' ? indexv : undefined );
}
}
// Normal navigation
else if( ( isOverview() || nextFragment() === false ) && availableRoutes().right ) {
slide( indexh + 1, config.navigationMode === 'grid' ? indexv : undefined );
}
2011-06-07 19:10:59 +00:00
}
2011-06-07 19:10:59 +00:00
function navigateUp() {
// Prioritize hiding fragments
2020-03-06 16:50:15 +00:00
if( ( isOverview() || prevFragment() === false ) && availableRoutes().up ) {
slide( indexh, indexv - 1 );
}
2011-06-07 19:10:59 +00:00
}
2011-06-07 19:10:59 +00:00
function navigateDown() {
2020-02-06 14:19:09 +00:00
hasNavigatedVertically = true;
// Prioritize revealing fragments
if( ( isOverview() || nextFragment() === false ) && availableRoutes().down ) {
slide( indexh, indexv + 1 );
}
2011-06-07 19:10:59 +00:00
}
/**
* Navigates backwards, prioritized in the following order:
* 1) Previous fragment
* 2) Previous vertical slide
* 3) Previous horizontal slide
*/
function navigatePrev() {
// Prioritize revealing fragments
2020-03-06 16:50:15 +00:00
if( prevFragment() === false ) {
if( availableRoutes().up ) {
navigateUp();
}
else {
2014-10-16 14:17:41 +00:00
// Fetch the previous horizontal slide, if there is one
2020-03-06 16:40:11 +00:00
let previousSlide;
2014-10-16 14:17:41 +00:00
if( config.rtl ) {
2014-10-16 14:17:41 +00:00
previousSlide = toArray( dom.wrapper.querySelectorAll( HORIZONTAL_SLIDES_SELECTOR + '.future' ) ).pop();
}
else {
previousSlide = toArray( dom.wrapper.querySelectorAll( HORIZONTAL_SLIDES_SELECTOR + '.past' ) ).pop();
}
if( previousSlide ) {
2020-03-06 16:40:11 +00:00
let v = ( previousSlide.querySelectorAll( 'section' ).length - 1 ) || undefined;
let h = indexh - 1;
2014-10-16 14:17:41 +00:00
slide( h, v );
}
}
}
}
/**
2014-10-16 14:17:41 +00:00
* The reverse of #navigatePrev().
*/
function navigateNext() {
2020-02-06 14:19:09 +00:00
hasNavigatedHorizontally = true;
hasNavigatedVertically = true;
// Prioritize revealing fragments
if( nextFragment() === false ) {
2020-03-06 16:40:11 +00:00
let routes = availableRoutes();
// When looping is enabled `routes.down` is always available
// so we need a separate check for when we've reached the
// end of a stack and should move horizontally
if( routes.down && routes.right && config.loop && Reveal.isLastVerticalSlide( currentSlide ) ) {
routes.down = false;
}
if( routes.down ) {
2014-10-16 14:17:41 +00:00
navigateDown();
}
else if( config.rtl ) {
navigateLeft();
}
else {
navigateRight();
2014-10-11 15:59:36 +00:00
}
}
}
2015-09-10 09:25:19 +00:00
/**
* Checks if the target element prevents the triggering of
* swipe navigation.
*/
function isSwipePrevented( target ) {
while( target && typeof target.hasAttribute === 'function' ) {
if( target.hasAttribute( 'data-prevent-swipe' ) ) return true;
target = target.parentNode;
}
return false;
}
// --------------------------------------------------------------------//
// ----------------------------- EVENTS -------------------------------//
// --------------------------------------------------------------------//
/**
* Called by all event handlers that are based on user
* input.
2016-06-30 03:10:55 +00:00
*
* @param {object} [event]
*/
function onUserInput( event ) {
if( config.autoSlideStoppable ) {
pauseAutoSlide();
}
}
/**
* Called whenever there is mouse input at the document level
* to determine if the cursor is active or not.
*
* @param {object} event
*/
function onDocumentCursorActive( event ) {
showCursor();
clearTimeout( cursorInactiveTimeout );
cursorInactiveTimeout = setTimeout( hideCursor, config.hideCursorTime );
}
/**
* Handler for the document level 'keypress' event.
2016-06-30 03:10:55 +00:00
*
* @param {object} event
*/
function onDocumentKeyPress( event ) {
// Check if the pressed key is question mark
if( event.shiftKey && event.charCode === 63 ) {
toggleHelp();
}
}
/**
* Handler for the document level 'keydown' event.
2016-06-30 03:10:55 +00:00
*
* @param {object} event
*/
function onDocumentKeyDown( event ) {
// If there's a condition specified and it returns false,
// ignore this event
if( typeof config.keyboardCondition === 'function' && config.keyboardCondition(event) === false ) {
return true;
}
2019-01-22 14:43:31 +00:00
// Shorthand
2020-03-06 16:40:11 +00:00
let keyCode = event.keyCode;
2019-01-22 14:43:31 +00:00
2013-12-21 17:12:02 +00:00
// Remember if auto-sliding was paused so we can toggle it
2020-03-06 16:40:11 +00:00
let autoSlideWasPaused = autoSlidePaused;
2013-12-21 17:12:02 +00:00
onUserInput( event );
// Is there a focused element that could be using the keyboard?
2020-03-06 16:40:11 +00:00
let activeElementIsCE = document.activeElement && document.activeElement.contentEditable !== 'inherit';
let activeElementIsInput = document.activeElement && document.activeElement.tagName && /input|textarea/i.test( document.activeElement.tagName );
let activeElementIsNotes = document.activeElement && document.activeElement.className && /speaker-notes/i.test( document.activeElement.className);
// Whitelist specific modified + keycode combinations
2020-03-06 16:40:11 +00:00
let prevSlideShortcut = event.shiftKey && event.keyCode === 32;
let firstSlideShortcut = event.shiftKey && keyCode === 37;
let lastSlideShortcut = event.shiftKey && keyCode === 39;
// Prevent all other events when a modifier is pressed
2020-03-06 16:40:11 +00:00
let unusedModifier = !prevSlideShortcut && !firstSlideShortcut && !lastSlideShortcut &&
( event.shiftKey || event.altKey || event.ctrlKey || event.metaKey );
// Disregard the event if there's a focused element or a
// keyboard modifier key is present
if( activeElementIsCE || activeElementIsInput || activeElementIsNotes || unusedModifier ) return;
// While paused only allow resume keyboard events; 'b', 'v', '.'
2020-03-06 16:40:11 +00:00
let resumeKeyCodes = [66,86,190,191];
let key;
2015-08-14 21:16:59 +00:00
// Custom key bindings for togglePause should be able to resume
if( typeof config.keyboard === 'object' ) {
2015-08-14 21:34:19 +00:00
for( key in config.keyboard ) {
2015-08-14 21:16:59 +00:00
if( config.keyboard[key] === 'togglePause' ) {
2015-08-14 21:25:30 +00:00
resumeKeyCodes.push( parseInt( key, 10 ) );
2015-08-14 21:16:59 +00:00
}
2015-08-14 21:25:30 +00:00
}
2015-08-14 21:16:59 +00:00
}
2015-06-03 09:59:00 +00:00
2019-01-22 14:43:31 +00:00
if( isPaused() && resumeKeyCodes.indexOf( keyCode ) === -1 ) {
return false;
}
// Use linear navigation if we're configured to OR if
// the presentation is one-dimensional
2020-03-06 16:40:11 +00:00
let useLinearMode = config.navigationMode === 'linear' || !hasHorizontalSlides() || !hasVerticalSlides();
2020-03-06 16:40:11 +00:00
let triggered = false;
2013-06-16 15:49:51 +00:00
// 1. User defined key bindings
if( typeof config.keyboard === 'object' ) {
2015-08-14 21:34:19 +00:00
for( key in config.keyboard ) {
2013-06-16 15:49:51 +00:00
// Check if this binding matches the pressed key
2019-01-22 14:43:31 +00:00
if( parseInt( key, 10 ) === keyCode ) {
2013-06-16 15:49:51 +00:00
2020-03-07 10:58:18 +00:00
let value = config.keyboard[ key ];
2013-06-16 15:49:51 +00:00
2013-07-10 13:01:56 +00:00
// Callback function
2013-06-16 15:49:51 +00:00
if( typeof value === 'function' ) {
value.apply( null, [ event ] );
}
// String shortcuts to reveal.js API
else if( typeof value === 'string' && typeof Reveal[ value ] === 'function' ) {
Reveal[ value ].call();
}
triggered = true;
}
}
}
// 2. Registered custom key bindings
if( triggered === false ) {
for( key in registeredKeyBindings ) {
// Check if this binding matches the pressed key
2019-01-22 14:43:31 +00:00
if( parseInt( key, 10 ) === keyCode ) {
2020-03-06 16:40:11 +00:00
let action = registeredKeyBindings[ key ].callback;
// Callback function
if( typeof action === 'function' ) {
action.apply( null, [ event ] );
}
// String shortcuts to reveal.js API
else if( typeof action === 'string' && typeof Reveal[ action ] === 'function' ) {
Reveal[ action ].call();
}
triggered = true;
}
}
}
// 3. System defined key bindings
2013-06-16 15:49:51 +00:00
if( triggered === false ) {
// Assume true and try to prove false
triggered = true;
2019-01-22 14:43:31 +00:00
// P, PAGE UP
if( keyCode === 80 || keyCode === 33 ) {
navigatePrev();
}
// N, PAGE DOWN
else if( keyCode === 78 || keyCode === 34 ) {
navigateNext();
}
// H, LEFT
else if( keyCode === 72 || keyCode === 37 ) {
if( firstSlideShortcut ) {
slide( 0 );
}
else if( !isOverview() && useLinearMode ) {
2019-01-22 14:43:31 +00:00
navigatePrev();
}
else {
navigateLeft();
}
}
// L, RIGHT
else if( keyCode === 76 || keyCode === 39 ) {
if( lastSlideShortcut ) {
slide( Number.MAX_VALUE );
}
else if( !isOverview() && useLinearMode ) {
2019-01-22 14:43:31 +00:00
navigateNext();
}
else {
navigateRight();
}
}
// K, UP
else if( keyCode === 75 || keyCode === 38 ) {
if( !isOverview() && useLinearMode ) {
2019-01-22 14:43:31 +00:00
navigatePrev();
}
else {
navigateUp();
2019-01-22 14:43:31 +00:00
}
}
// J, DOWN
else if( keyCode === 74 || keyCode === 40 ) {
if( !isOverview() && useLinearMode ) {
navigateNext();
2019-01-22 14:43:31 +00:00
}
else {
navigateDown();
2019-01-22 14:43:31 +00:00
}
}
// HOME
else if( keyCode === 36 ) {
slide( 0 );
}
// END
else if( keyCode === 35 ) {
slide( Number.MAX_VALUE );
}
// SPACE
else if( keyCode === 32 ) {
if( isOverview() ) {
deactivateOverview();
}
if( event.shiftKey ) {
navigatePrev();
}
else {
navigateNext();
}
}
// TWO-SPOT, SEMICOLON, B, V, PERIOD, LOGITECH PRESENTER TOOLS "BLACK SCREEN" BUTTON
else if( keyCode === 58 || keyCode === 59 || keyCode === 66 || keyCode === 86 || keyCode === 190 || keyCode === 191 ) {
togglePause();
}
// F
else if( keyCode === 70 ) {
enterFullscreen();
}
// A
else if( keyCode === 65 ) {
if ( config.autoSlideStoppable ) {
toggleAutoSlide( autoSlideWasPaused );
}
}
else {
triggered = false;
2013-06-16 15:49:51 +00:00
}
}
// If the input resulted in a triggered action we should prevent
// the browsers default behavior
if( triggered ) {
2014-05-04 07:32:10 +00:00
event.preventDefault && event.preventDefault();
}
// ESC or O key
else if( keyCode === 27 || keyCode === 79 ) {
if( dom.overlay ) {
closeOverlay();
}
else {
toggleOverview();
}
2014-05-04 07:32:10 +00:00
event.preventDefault && event.preventDefault();
}
// If auto-sliding is enabled we need to cue up
// another timeout
cueAutoSlide();
}
/**
2013-03-09 00:31:36 +00:00
* Handler for the 'touchstart' event, enables support for
* swipe and pinch gestures.
2016-06-30 03:10:55 +00:00
*
* @param {object} event
*/
function onTouchStart( event ) {
2015-09-10 09:25:19 +00:00
if( isSwipePrevented( event.target ) ) return true;
touch.startX = event.touches[0].clientX;
touch.startY = event.touches[0].clientY;
touch.startCount = event.touches.length;
}
/**
* Handler for the 'touchmove' event.
2016-06-30 03:10:55 +00:00
*
* @param {object} event
*/
function onTouchMove( event ) {
2015-09-10 09:25:19 +00:00
if( isSwipePrevented( event.target ) ) return true;
// Each touch should only trigger one action
2013-08-10 18:09:23 +00:00
if( !touch.captured ) {
onUserInput( event );
2020-03-06 16:40:11 +00:00
let currentX = event.touches[0].clientX;
let currentY = event.touches[0].clientY;
// There was only one touch point, look for a swipe
if( event.touches.length === 1 && touch.startCount !== 2 ) {
2020-03-06 16:40:11 +00:00
let deltaX = currentX - touch.startX,
deltaY = currentY - touch.startY;
if( deltaX > touch.threshold && Math.abs( deltaX ) > Math.abs( deltaY ) ) {
2013-08-10 18:09:23 +00:00
touch.captured = true;
2019-06-10 05:13:54 +00:00
if( config.navigationMode === 'linear' ) {
if( config.rtl ) {
navigateNext();
}
else {
navigatePrev();
}
}
else {
navigateLeft();
}
}
else if( deltaX < -touch.threshold && Math.abs( deltaX ) > Math.abs( deltaY ) ) {
2013-08-10 18:09:23 +00:00
touch.captured = true;
2019-06-10 05:13:54 +00:00
if( config.navigationMode === 'linear' ) {
if( config.rtl ) {
navigatePrev();
}
else {
navigateNext();
}
}
else {
navigateRight();
}
}
else if( deltaY > touch.threshold ) {
2013-08-10 18:09:23 +00:00
touch.captured = true;
2019-06-10 05:13:54 +00:00
if( config.navigationMode === 'linear' ) {
navigatePrev();
}
else {
navigateUp();
}
}
else if( deltaY < -touch.threshold ) {
2013-08-10 18:09:23 +00:00
touch.captured = true;
2019-06-10 05:13:54 +00:00
if( config.navigationMode === 'linear' ) {
navigateNext();
}
else {
navigateDown();
}
}
2013-08-10 18:30:24 +00:00
// If we're embedded, only block touch events if they have
// triggered an action
if( config.embedded ) {
2013-08-10 18:30:24 +00:00
if( touch.captured || isVerticalSlide( currentSlide ) ) {
event.preventDefault();
}
}
// Not embedded? Block them all to avoid needless tossing
// around of the viewport in iOS
else {
event.preventDefault();
}
}
}
// There's a bug with swiping on some Android devices unless
// the default action is always prevented
else if( UA.match( /android/gi ) ) {
event.preventDefault();
}
}
/**
* Handler for the 'touchend' event.
2016-06-30 03:10:55 +00:00
*
* @param {object} event
*/
function onTouchEnd( event ) {
2013-08-10 18:09:23 +00:00
touch.captured = false;
}
/**
* Convert pointer down to touch start.
2016-06-30 03:10:55 +00:00
*
* @param {object} event
*/
function onPointerDown( event ) {
2013-12-02 22:23:51 +00:00
if( event.pointerType === event.MSPOINTER_TYPE_TOUCH || event.pointerType === "touch" ) {
event.touches = [{ clientX: event.clientX, clientY: event.clientY }];
2013-03-05 14:48:42 +00:00
onTouchStart( event );
}
}
/**
* Convert pointer move to touch move.
2016-06-30 03:10:55 +00:00
*
* @param {object} event
*/
function onPointerMove( event ) {
2013-12-02 22:23:51 +00:00
if( event.pointerType === event.MSPOINTER_TYPE_TOUCH || event.pointerType === "touch" ) {
event.touches = [{ clientX: event.clientX, clientY: event.clientY }];
2013-03-05 14:48:42 +00:00
onTouchMove( event );
}
}
/**
* Convert pointer up to touch end.
2016-06-30 03:10:55 +00:00
*
* @param {object} event
*/
function onPointerUp( event ) {
2013-12-02 22:23:51 +00:00
if( event.pointerType === event.MSPOINTER_TYPE_TOUCH || event.pointerType === "touch" ) {
event.touches = [{ clientX: event.clientX, clientY: event.clientY }];
2013-03-05 14:48:42 +00:00
onTouchEnd( event );
}
}
/**
* Handles mouse wheel scrolling, throttled to avoid skipping
* multiple slides.
2016-06-30 03:10:55 +00:00
*
* @param {object} event
*/
function onDocumentMouseScroll( event ) {
2013-06-16 23:55:50 +00:00
if( Date.now() - lastMouseWheelStep > 600 ) {
lastMouseWheelStep = Date.now();
2020-03-06 16:40:11 +00:00
let delta = event.detail || -event.wheelDelta;
if( delta > 0 ) {
navigateNext();
}
else if( delta < 0 ) {
navigatePrev();
}
2013-06-16 23:55:50 +00:00
}
}
/**
* Clicking on the progress bar results in a navigation to the
* closest approximate horizontal slide using this equation:
*
* ( clickX / presentationWidth ) * numberOfSlides
2016-06-30 03:10:55 +00:00
*
* @param {object} event
*/
function onProgressClicked( event ) {
onUserInput( event );
event.preventDefault();
2020-03-06 16:40:11 +00:00
let slidesTotal = getHorizontalSlides().length;
let slideIndex = Math.floor( ( event.clientX / dom.wrapper.offsetWidth ) * slidesTotal );
if( config.rtl ) {
slideIndex = slidesTotal - slideIndex;
}
slide( slideIndex );
}
/**
* Event handler for navigation control buttons.
*/
function onNavigateLeftClicked( event ) { event.preventDefault(); onUserInput(); config.navigationMode === 'linear' ? navigatePrev() : navigateLeft(); }
function onNavigateRightClicked( event ) { event.preventDefault(); onUserInput(); config.navigationMode === 'linear' ? navigateNext() : navigateRight(); }
function onNavigateUpClicked( event ) { event.preventDefault(); onUserInput(); navigateUp(); }
function onNavigateDownClicked( event ) { event.preventDefault(); onUserInput(); navigateDown(); }
function onNavigatePrevClicked( event ) { event.preventDefault(); onUserInput(); navigatePrev(); }
function onNavigateNextClicked( event ) { event.preventDefault(); onUserInput(); navigateNext(); }
/**
* Handler for the window level 'hashchange' event.
2016-06-30 03:10:55 +00:00
*
* @param {object} [event]
*/
function onWindowHashChange( event ) {
readURL();
}
/**
* Handler for the window level 'resize' event.
2016-06-30 03:10:55 +00:00
*
* @param {object} [event]
*/
function onWindowResize( event ) {
layout();
}
/**
* Handle for the window level 'visibilitychange' event.
2016-06-30 03:10:55 +00:00
*
* @param {object} [event]
*/
function onPageVisibilityChange( event ) {
// If, after clicking a link or similar and we're coming back,
// focus the document.body to ensure we can use keyboard shortcuts
2020-03-02 13:52:50 +00:00
if( document.hidden === false && document.activeElement !== document.body ) {
// Not all elements support .blur() - SVGs among them.
2015-03-02 11:11:05 +00:00
if( typeof document.activeElement.blur === 'function' ) {
document.activeElement.blur();
}
document.body.focus();
}
}
/**
* Invoked when a slide is and we're in the overview.
2016-06-30 03:10:55 +00:00
*
* @param {object} event
*/
function onOverviewSlideClicked( event ) {
// TODO There's a bug here where the event listeners are not
// removed after deactivating the overview.
if( eventsAreBound && isOverview() ) {
event.preventDefault();
2020-03-06 16:40:11 +00:00
let element = event.target;
2012-11-11 15:01:05 +00:00
while( element && !element.nodeName.match( /section/gi ) ) {
element = element.parentNode;
}
if( element && !element.classList.contains( 'disabled' ) ) {
deactivateOverview();
if( element.nodeName.match( /section/gi ) ) {
2020-03-07 10:58:18 +00:00
let h = parseInt( element.getAttribute( 'data-index-h' ), 10 ),
v = parseInt( element.getAttribute( 'data-index-v' ), 10 );
slide( h, v );
}
}
}
}
/**
* Handles clicks on links that are set to preview in the
* iframe overlay.
2016-06-30 03:10:55 +00:00
*
* @param {object} event
*/
function onPreviewLinkClicked( event ) {
2014-09-04 16:00:21 +00:00
if( event.currentTarget && event.currentTarget.hasAttribute( 'href' ) ) {
2020-03-06 16:40:11 +00:00
let url = event.currentTarget.getAttribute( 'href' );
2014-09-04 16:00:21 +00:00
if( url ) {
showPreview( url );
event.preventDefault();
}
}
}
/**
* Handles click on the auto-sliding controls element.
2016-06-30 03:10:55 +00:00
*
* @param {object} [event]
*/
function onAutoSlidePlayerClick( event ) {
// Replay
if( Reveal.isLastSlide() && config.loop === false ) {
slide( 0, 0 );
resumeAutoSlide();
}
// Resume
else if( autoSlidePaused ) {
resumeAutoSlide();
}
// Pause
else {
pauseAutoSlide();
}
}
// --------------------------------------------------------------------//
// ------------------------------- API --------------------------------//
// --------------------------------------------------------------------//
2014-04-09 00:08:21 +00:00
Reveal = {
2016-01-08 09:26:41 +00:00
VERSION: VERSION,
initialize,
2020-03-06 16:50:15 +00:00
configure,
2018-05-31 08:35:07 +00:00
2020-03-06 16:50:15 +00:00
sync,
syncSlide,
syncFragments,
// Navigation methods
2020-03-06 16:50:15 +00:00
slide,
left: navigateLeft,
right: navigateRight,
up: navigateUp,
down: navigateDown,
prev: navigatePrev,
next: navigateNext,
// Deprecated aliases
navigateTo: slide,
2011-06-07 19:10:59 +00:00
navigateLeft: navigateLeft,
navigateRight: navigateRight,
navigateUp: navigateUp,
navigateDown: navigateDown,
2012-06-11 22:28:17 +00:00
navigatePrev: navigatePrev,
navigateNext: navigateNext,
2020-03-06 16:50:15 +00:00
// Fragment methods
navigateFragment,
prevFragment,
nextFragment,
// Forces an update in slide layout
2020-03-06 16:50:15 +00:00
layout,
// Randomizes the order of slides
2020-03-06 16:50:15 +00:00
shuffle,
2013-03-23 15:42:21 +00:00
// Returns an object with the available routes as booleans (left/right/top/bottom)
2020-03-06 16:50:15 +00:00
availableRoutes,
2013-03-23 15:42:21 +00:00
// Returns an object with the available fragments as booleans (prev/next)
2020-03-06 16:50:15 +00:00
availableFragments,
2017-02-09 10:37:47 +00:00
// Toggles a help overlay with keyboard shortcuts
2020-03-06 16:50:15 +00:00
toggleHelp,
2017-02-09 10:37:47 +00:00
// Toggles the overview mode on/off
2020-03-06 16:50:15 +00:00
toggleOverview,
2013-01-18 16:01:09 +00:00
// Toggles the "black screen" mode on/off
2020-03-06 16:50:15 +00:00
togglePause,
2013-01-18 16:01:09 +00:00
// Toggles the auto slide mode on/off
2020-03-06 16:50:15 +00:00
toggleAutoSlide,
// State checks
2020-03-06 16:50:15 +00:00
isOverview,
isPaused,
isAutoSliding,
isSpeakerNotes,
// Slide preloading
2020-03-06 16:50:15 +00:00
loadSlide,
unloadSlide,
// Adds or removes all internal event listeners (such as keyboard)
2020-03-06 16:50:15 +00:00
addEventListeners,
removeEventListeners,
// Facility for persisting and restoring the presentation state
2020-03-06 16:50:15 +00:00
getState,
setState,
// Presentation progress
2020-03-06 16:50:15 +00:00
getSlidePastCount,
2014-03-12 21:26:31 +00:00
// Presentation progress on range of 0-1
2020-03-06 16:50:15 +00:00
getProgress,
2014-03-12 21:26:31 +00:00
2012-08-21 02:13:00 +00:00
// Returns the indices of the current, or specified, slide
2020-03-06 16:50:15 +00:00
getIndices,
// Returns an Array of all slides
2020-03-06 16:50:15 +00:00
getSlides,
2018-02-20 15:08:29 +00:00
// Returns an Array of objects representing the attributes on
// the slides
2020-03-06 16:50:15 +00:00
getSlidesAttributes,
// Returns the total number of slides
2020-03-06 16:50:15 +00:00
getTotalSlides,
2014-04-01 07:12:41 +00:00
2014-04-27 12:46:49 +00:00
// Returns the slide element at the specified index
2020-03-06 16:50:15 +00:00
getSlide,
2014-04-27 12:46:49 +00:00
// Returns the slide background element at the specified index
2020-03-06 16:50:15 +00:00
getSlideBackground,
2015-09-10 06:28:52 +00:00
// Returns the speaker notes string for a slide, or null
2020-03-06 16:50:15 +00:00
getSlideNotes,
2015-09-10 06:28:52 +00:00
// Returns an array with all horizontal/vertical slides in the deck
2020-03-06 16:50:15 +00:00
getHorizontalSlides,
getVerticalSlides,
// Checks if the presentation contains two or more
// horizontal/vertical slides
2020-03-06 16:50:15 +00:00
hasHorizontalSlides,
hasVerticalSlides,
// Adds/removes a custom key binding
addKeyBinding,
removeKeyBinding,
// API for registering and retrieving plugins
registerPlugin: (...args) => plugins.registerPlugin( ...args ),
hasPlugin: (...args) => plugins.hasPlugin( ...args ),
getPlugin: (...args) => plugins.getPlugin( ...args ),
// Returns a hash with all registered plugins
getPlugins: () => plugins.getRegisteredPlugins(),
2020-03-06 16:50:15 +00:00
getComputedSlideSize,
// Returns the previous slide element, may be null
getPreviousSlide: () => previousSlide,
// Returns the current slide element
getCurrentSlide: () => currentSlide,
// Returns the current scale of the presentation content
getScale: () => scale,
// Returns the current configuration object
getConfig: () => config,
// Helper method, retrieves query string as a key/value hash
2020-03-06 16:40:11 +00:00
getQueryHash: () => {
let query = {};
2020-03-06 16:40:11 +00:00
location.search.replace( /[A-Z0-9]+?=([\w\.%-]*)/gi, a => {
query[ a.split( '=' ).shift() ] = a.split( '=' ).pop();
} );
// Basic deserialization
2020-03-06 16:40:11 +00:00
for( let i in query ) {
let value = query[ i ];
2013-11-27 18:16:03 +00:00
2014-03-12 07:51:51 +00:00
query[ i ] = deserialize( unescape( value ) );
}
return query;
},
2018-11-16 09:39:43 +00:00
// Returns the top-level DOM element
getRevealElement: () => dom.wrapper || document.querySelector( '.reveal' ),
2018-11-16 09:39:43 +00:00
// Returns true if we're currently on the first slide
isFirstSlide: () => indexh === 0 && indexv === 0,
// Returns true if we're currently on the last slide
2020-03-06 16:40:11 +00:00
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;
},
// Returns true if we're on the last slide in the current
// vertical stack
2020-03-06 16:40:11 +00:00
isLastVerticalSlide: () => {
if( currentSlide && isVerticalSlide( currentSlide ) ) {
// Does this slide have a next sibling?
if( currentSlide.nextElementSibling ) return false;
return true;
}
return false;
},
// Checks if reveal.js has been loaded and is ready for use
isReady: () => ready,
// Forward event binding to the reveal DOM element
2020-03-06 16:40:11 +00:00
addEventListener: ( type, listener, useCapture ) => {
Reveal.getRevealElement().addEventListener( type, listener, useCapture );
},
2020-03-06 16:40:11 +00:00
removeEventListener: ( type, listener, useCapture ) => {
Reveal.getRevealElement().removeEventListener( type, listener, useCapture );
},
2019-04-01 12:29:26 +00:00
// Programmatically triggers a keyboard event
triggerKey: keyCode => onDocumentKeyDown( { keyCode } ),
// Registers a new shortcut to include in the help overlay
registerKeyboardShortcut: ( key, value ) => keyboardShortcuts[key] = value
2011-06-07 19:10:59 +00:00
};
return Reveal;
2014-04-09 00:08:21 +00:00
};