|
@@ -2,7 +2,8 @@ import { SLIDES_SELECTOR } from '../utils/constants.js'
|
|
|
import { queryAll, createStyleSheet } from '../utils/util.js'
|
|
|
|
|
|
/**
|
|
|
- * Setups up our presentation for printing/exporting to PDF.
|
|
|
+ * The reader mode lets you read a reveal.js presentation
|
|
|
+ * as a linear scrollable page.
|
|
|
*/
|
|
|
export default class Reader {
|
|
|
|
|
@@ -12,47 +13,23 @@ export default class Reader {
|
|
|
|
|
|
}
|
|
|
|
|
|
- /**
|
|
|
- * Configures the presentation for printing to a static.
|
|
|
- */
|
|
|
- async setup() {
|
|
|
-
|
|
|
- const printing = this.isPrintMode();
|
|
|
+ async activate() {
|
|
|
|
|
|
- const config = this.Reveal.getConfig();
|
|
|
- const slides = queryAll( this.Reveal.getRevealElement(), SLIDES_SELECTOR )
|
|
|
+ const slides = queryAll( this.Reveal.getRevealElement(), SLIDES_SELECTOR );
|
|
|
|
|
|
- // Compute slide numbers now, before we start duplicating slides
|
|
|
- const injectPageNumbers = config.slideNumber && /all|print/i.test( config.showSlideNumber );
|
|
|
+ const viewportElement = this.Reveal.getViewportElement();
|
|
|
|
|
|
const slideSize = this.Reveal.getComputedSlideSize( window.innerWidth, window.innerHeight );
|
|
|
|
|
|
- // Dimensions of the PDF pages
|
|
|
- const pageWidth = Math.floor( slideSize.width * ( 1 + config.margin ) ),
|
|
|
- pageHeight = Math.floor( slideSize.height * ( 1 + config.margin ) );
|
|
|
-
|
|
|
// Dimensions of slides within the pages
|
|
|
const slideWidth = slideSize.width,
|
|
|
slideHeight = slideSize.height;
|
|
|
|
|
|
await new Promise( requestAnimationFrame );
|
|
|
|
|
|
- // Let the browser know what page size we want to print
|
|
|
- createStyleSheet( '@page{size:'+ pageWidth +'px '+ pageHeight +'px; margin: 0px;}' );
|
|
|
-
|
|
|
- // Limit the size of certain elements to the dimensions of the slide
|
|
|
- createStyleSheet( '.reveal section>img, .reveal section>video, .reveal section>iframe{max-width: '+ slideWidth +'px; max-height:'+ slideHeight +'px}' );
|
|
|
+ viewportElement.classList.add( 'reveal-reader' );
|
|
|
+ viewportElement.addEventListener( 'scroll', this.onScroll.bind( this ) );
|
|
|
|
|
|
- if( printing ) {
|
|
|
- document.documentElement.classList.add( 'reveal-print', 'print-pdf' );
|
|
|
- document.body.style.width = pageWidth + 'px';
|
|
|
- document.body.style.height = pageHeight + 'px';
|
|
|
- }
|
|
|
- else {
|
|
|
- document.documentElement.classList.add( 'reveal-reader' );
|
|
|
- }
|
|
|
-
|
|
|
- const viewportElement = document.querySelector( '.reveal-viewport' );
|
|
|
let presentationBackground;
|
|
|
if( viewportElement ) {
|
|
|
const viewportStyles = window.getComputedStyle( viewportElement );
|
|
@@ -65,43 +42,25 @@ export default class Reader {
|
|
|
await new Promise( requestAnimationFrame );
|
|
|
this.Reveal.layoutSlideContents( slideWidth, slideHeight );
|
|
|
|
|
|
- // Batch scrollHeight access to prevent layout thrashing
|
|
|
- await new Promise( requestAnimationFrame );
|
|
|
-
|
|
|
- const slideScrollHeights = slides.map( slide => slide.scrollHeight );
|
|
|
-
|
|
|
const pages = [];
|
|
|
const pageContainer = slides[0].parentNode;
|
|
|
- let slideNumber = 1;
|
|
|
|
|
|
// Slide and slide background layout
|
|
|
- slides.forEach( function( slide, index ) {
|
|
|
+ slides.forEach( function( slide ) {
|
|
|
|
|
|
// Vertical stacks are not centred since their section
|
|
|
// children will be
|
|
|
if( slide.classList.contains( 'stack' ) === false ) {
|
|
|
- // Center the slide inside of the page, giving the slide some margin
|
|
|
- let left = ( pageWidth - slideWidth ) / 2;
|
|
|
- let top = ( pageHeight - slideHeight ) / 2;
|
|
|
-
|
|
|
- const contentHeight = slideScrollHeights[ index ];
|
|
|
- let numberOfPages = Math.max( Math.ceil( contentHeight / pageHeight ), 1 );
|
|
|
-
|
|
|
- // Adhere to configured pages per slide limit
|
|
|
- numberOfPages = Math.min( numberOfPages, config.pdfMaxPagesPerSlide );
|
|
|
-
|
|
|
- // 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
|
|
|
const page = document.createElement( 'div' );
|
|
|
pages.push( page );
|
|
|
|
|
|
- page.className = printing ? 'pdf-page' : 'reader-page';
|
|
|
- page.style.height = ( ( pageHeight + config.pdfPageHeightOffset ) * numberOfPages ) + 'px';
|
|
|
+ page.className = 'reader-page';
|
|
|
+ page.style.width = slideWidth + 'px';
|
|
|
+ page.style.height = slideHeight + 'px';
|
|
|
+
|
|
|
+ slide.style.width = slideWidth + 'px';
|
|
|
|
|
|
// Copy the presentation-wide background to each individual
|
|
|
// page when printing
|
|
@@ -111,164 +70,143 @@ export default class Reader {
|
|
|
|
|
|
page.appendChild( slide );
|
|
|
|
|
|
- // Position the slide inside of the page
|
|
|
- if( printing ) {
|
|
|
- slide.style.left = left + 'px';
|
|
|
- slide.style.top = top + 'px';
|
|
|
- }
|
|
|
-
|
|
|
- slide.style.width = slideWidth + 'px';
|
|
|
-
|
|
|
- this.Reveal.slideContent.layout( slide );
|
|
|
-
|
|
|
if( slide.slideBackgroundElement ) {
|
|
|
page.insertBefore( slide.slideBackgroundElement, slide );
|
|
|
}
|
|
|
|
|
|
- // Inject notes if `showNotes` is enabled
|
|
|
- if( config.showNotes ) {
|
|
|
-
|
|
|
- // Are there notes for this slide?
|
|
|
- const notes = this.Reveal.getSlideNotes( slide );
|
|
|
- if( notes ) {
|
|
|
+ }
|
|
|
|
|
|
- const notesSpacing = 8;
|
|
|
- const notesLayout = typeof config.showNotes === 'string' ? config.showNotes : 'inline';
|
|
|
- const notesElement = document.createElement( 'div' );
|
|
|
- notesElement.classList.add( 'speaker-notes' );
|
|
|
- notesElement.classList.add( 'speaker-notes-pdf' );
|
|
|
- notesElement.setAttribute( 'data-layout', notesLayout );
|
|
|
- notesElement.innerHTML = notes;
|
|
|
+ }, this );
|
|
|
|
|
|
- if( notesLayout === 'separate-page' ) {
|
|
|
- pages.push( notesElement );
|
|
|
- }
|
|
|
- else {
|
|
|
- notesElement.style.left = notesSpacing + 'px';
|
|
|
- notesElement.style.bottom = notesSpacing + 'px';
|
|
|
- notesElement.style.width = ( pageWidth - notesSpacing*2 ) + 'px';
|
|
|
- page.appendChild( notesElement );
|
|
|
- }
|
|
|
+ // Remove leftover stacks
|
|
|
+ queryAll( this.Reveal.getRevealElement(), '.stack' ).forEach( stack => stack.remove() );
|
|
|
|
|
|
- }
|
|
|
+ await new Promise( requestAnimationFrame );
|
|
|
|
|
|
- }
|
|
|
+ pages.forEach( page => pageContainer.appendChild( page ) );
|
|
|
|
|
|
- // Inject page numbers if `slideNumbers` are enabled
|
|
|
- if( injectPageNumbers ) {
|
|
|
- const numberElement = document.createElement( 'div' );
|
|
|
- numberElement.classList.add( 'slide-number' );
|
|
|
- numberElement.classList.add( 'slide-number-pdf' );
|
|
|
- numberElement.innerHTML = slideNumber++;
|
|
|
- page.appendChild( numberElement );
|
|
|
- }
|
|
|
+ // Re-run JS-based content layout after the slide is added to page DOM
|
|
|
+ this.Reveal.slideContent.layout( this.Reveal.getSlidesElement() );
|
|
|
|
|
|
- // Copy page and show fragments one after another
|
|
|
- if( config.pdfSeparateFragments ) {
|
|
|
+ this.Reveal.layout();
|
|
|
|
|
|
- // 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.
|
|
|
- const fragmentGroups = this.Reveal.fragments.sort( page.querySelectorAll( '.fragment' ), true );
|
|
|
+ }
|
|
|
|
|
|
- let previousFragmentStep;
|
|
|
+ /**
|
|
|
+ * Checks if the reader mode is/should be activated.
|
|
|
+ */
|
|
|
+ isActive() {
|
|
|
|
|
|
- fragmentGroups.forEach( function( fragments, index ) {
|
|
|
+ if( typeof this._isReaderMode === 'undefined' ) {
|
|
|
+ this._isReaderMode = this.Reveal.getConfig().mode === 'reader';
|
|
|
+ }
|
|
|
|
|
|
- // Remove 'current-fragment' from the previous group
|
|
|
- if( previousFragmentStep ) {
|
|
|
- previousFragmentStep.forEach( function( fragment ) {
|
|
|
- fragment.classList.remove( 'current-fragment' );
|
|
|
- } );
|
|
|
- }
|
|
|
+ return this._isReaderMode;
|
|
|
|
|
|
- // Show the fragments for the current index
|
|
|
- fragments.forEach( function( fragment ) {
|
|
|
- fragment.classList.add( 'visible', 'current-fragment' );
|
|
|
- }, this );
|
|
|
+ }
|
|
|
|
|
|
- // Create a separate page for the current fragment state
|
|
|
- const clonedPage = page.cloneNode( true );
|
|
|
+ generatePageMap() {
|
|
|
|
|
|
- // Inject unique page numbers for fragments
|
|
|
- if( injectPageNumbers ) {
|
|
|
- const numberElement = clonedPage.querySelector( '.slide-number-pdf' );
|
|
|
- const fragmentNumber = index + 1;
|
|
|
- numberElement.innerHTML += '.' + fragmentNumber;
|
|
|
- }
|
|
|
+ const slideSize = this.Reveal.getComputedSlideSize( window.innerWidth, window.innerHeight );
|
|
|
+ const scale = this.Reveal.getScale();
|
|
|
|
|
|
- pages.push( clonedPage );
|
|
|
+ // The height that needs to be scrolled between scroll triggers
|
|
|
+ const scrollTriggerHeight = slideSize.height * scale / 2;
|
|
|
|
|
|
- previousFragmentStep = fragments;
|
|
|
+ this.pageElements = Array.from( this.Reveal.getRevealElement().querySelectorAll( '.reader-page' ) );
|
|
|
|
|
|
- }, this );
|
|
|
+ this.pageMap = this.pageElements.map( pageElement => {
|
|
|
+ const page = {
|
|
|
+ pageElement: pageElement,
|
|
|
+ slideElement: pageElement.querySelector( 'section' ),
|
|
|
+ top: pageElement.offsetTop * scale,
|
|
|
+ pageHeight: pageElement.offsetHeight * scale,
|
|
|
+ scrollTriggers: []
|
|
|
+ };
|
|
|
|
|
|
- // 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' );
|
|
|
- } );
|
|
|
- } );
|
|
|
+ page.fragments = this.Reveal.fragments.sort( pageElement.querySelectorAll( '.fragment:not(.disabled)' ) );
|
|
|
|
|
|
- }
|
|
|
- // Show all fragments
|
|
|
- else {
|
|
|
- queryAll( page, '.fragment:not(.fade-out)' ).forEach( function( fragment ) {
|
|
|
- fragment.classList.add( 'visible' );
|
|
|
- } );
|
|
|
- }
|
|
|
+ // 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.
|
|
|
+ page.fragmentGroups = this.Reveal.fragments.sort( pageElement.querySelectorAll( '.fragment' ), true );
|
|
|
|
|
|
- }
|
|
|
+ // The amount of empty scrollable space that has been append
|
|
|
+ page.scrollHeight = scrollTriggerHeight * Math.max( page.fragmentGroups.length - 1, 0 );
|
|
|
|
|
|
- }, this );
|
|
|
+ // The total height including scrollable space
|
|
|
+ page.totalHeight = page.pageHeight + page.scrollHeight;
|
|
|
|
|
|
- // Remove leftover stacks
|
|
|
- queryAll( pageContainer, '.reveal .stack' ).forEach( stack => stack.remove() );
|
|
|
+ page.bottom = page.top + page.totalHeight;
|
|
|
|
|
|
- await new Promise( requestAnimationFrame );
|
|
|
+ // Pad the page height to reserve scrollable height
|
|
|
+ page.pageElement.style.marginBottom = page.scrollHeight + 'px';
|
|
|
|
|
|
- pages.forEach( page => pageContainer.appendChild( page ) );
|
|
|
+ // Create scroll triggers that show/hide fragments
|
|
|
+ if( page.fragmentGroups.length ) {
|
|
|
+ const segmentSize = 1 / ( page.fragmentGroups.length + 1 );
|
|
|
+ page.scrollTriggers.push(
|
|
|
+ // Trigger for the initial state with no fragments visible
|
|
|
+ { range: [ 0, segmentSize ], fragmentIndex: -1 },
|
|
|
|
|
|
- // Re-run JS-based content layout after the slide is added to page DOM
|
|
|
- this.Reveal.slideContent.layout( this.Reveal.getSlidesElement() );
|
|
|
+ // Triggers for each fragment group
|
|
|
+ ...page.fragmentGroups.map( ( fragments, i ) => ({
|
|
|
+ range: [ segmentSize * ( i + 1 ), segmentSize * ( i + 2 ) ],
|
|
|
+ fragmentIndex: i
|
|
|
+ }))
|
|
|
+ );
|
|
|
+ }
|
|
|
|
|
|
- if( printing ) {
|
|
|
- // Notify subscribers that the PDF layout is good to go
|
|
|
- this.Reveal.dispatchEvent({ type: 'pdf-ready' });
|
|
|
- }
|
|
|
+ return page;
|
|
|
+ } );
|
|
|
|
|
|
}
|
|
|
|
|
|
- /**
|
|
|
- * Checks if reveal.js was initialized in printing mode.
|
|
|
- */
|
|
|
- isPrintMode() {
|
|
|
+ update() {
|
|
|
|
|
|
- if( typeof this._isPrintMode === 'undefined' ) {
|
|
|
- this._isPrintMode = this.Reveal.getConfig().mode === 'pdf' ||
|
|
|
- ( /print-pdf/gi ).test( window.location.search );
|
|
|
- }
|
|
|
-
|
|
|
- return this._isPrintMode;
|
|
|
+ this.generatePageMap();
|
|
|
+ this.onScroll();
|
|
|
|
|
|
}
|
|
|
|
|
|
- /**
|
|
|
- * Checks if reveal.js was initialized in reader mode.
|
|
|
- */
|
|
|
- isReaderMode() {
|
|
|
+ onScroll() {
|
|
|
|
|
|
- if( typeof this._isReaderMode === 'undefined' ) {
|
|
|
- this._isReaderMode = this.Reveal.getConfig().mode === 'reader';
|
|
|
- }
|
|
|
+ const viewportElement = this.Reveal.getViewportElement();
|
|
|
|
|
|
- return this._isReaderMode;
|
|
|
+ const scrollTop = viewportElement.scrollTop;
|
|
|
+ const scale = this.Reveal.getScale();
|
|
|
|
|
|
- }
|
|
|
+ this.pageMap.forEach( ( page, i ) => {
|
|
|
+ const isPartiallyVisible = scrollTop >= page.top && scrollTop < page.top + page.bottom;
|
|
|
|
|
|
- isActive() {
|
|
|
+ if( isPartiallyVisible ) {
|
|
|
+ // Load the slide content when it becomes visible
|
|
|
+ if( !page.visible ) {
|
|
|
+ page.visible = true;
|
|
|
+ this.Reveal.slideContent.load( page.slideElement );
|
|
|
+ this.Reveal.slideContent.startEmbeddedContent( page.slideElement );
|
|
|
+ }
|
|
|
+
|
|
|
+ if( page.totalHeight > page.pageHeight ) {
|
|
|
+ const scrollProgress = Math.min( ( scrollTop - page.top ) / page.scrollHeight, 1 );
|
|
|
+
|
|
|
+ // Fix the slide to the top of the viewport while we're in its
|
|
|
+ // scrollable region
|
|
|
+ page.pageElement.style.transform = `translateY( ${ scrollProgress * page.scrollHeight / scale }px )`;
|
|
|
|
|
|
- return this.isPrintMode() || this.isReaderMode();
|
|
|
+ page.scrollTriggers.forEach( trigger => {
|
|
|
+ if( scrollProgress >= trigger.range[0] && scrollProgress < trigger.range[1] ) {
|
|
|
+ this.Reveal.fragments.update( trigger.fragmentIndex, page.fragments );
|
|
|
+ }
|
|
|
+ } );
|
|
|
+ }
|
|
|
+ }
|
|
|
+ else if( page.visible ) {
|
|
|
+ page.visible = false;
|
|
|
+ this.Reveal.slideContent.unload( page.slideElement );
|
|
|
+ this.Reveal.slideContent.stopEmbeddedContent( page.slideElement );
|
|
|
+ }
|
|
|
+ } );
|
|
|
|
|
|
}
|
|
|
|