print.js 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202
  1. import { SLIDES_SELECTOR } from '../utils/constants.js'
  2. import { queryAll, createStyleSheet } from '../utils/util.js'
  3. /**
  4. * Setups up our presentation for printing/exporting to PDF.
  5. */
  6. export default class Print {
  7. constructor( Reveal ) {
  8. this.Reveal = Reveal;
  9. }
  10. /**
  11. * Configures the presentation for printing to a static
  12. * PDF.
  13. */
  14. async setupPDF() {
  15. let config = this.Reveal.getConfig();
  16. let slideSize = this.Reveal.getComputedSlideSize( window.innerWidth, window.innerHeight );
  17. // Dimensions of the PDF pages
  18. let pageWidth = Math.floor( slideSize.width * ( 1 + config.margin ) ),
  19. pageHeight = Math.floor( slideSize.height * ( 1 + config.margin ) );
  20. // Dimensions of slides within the pages
  21. let slideWidth = slideSize.width,
  22. slideHeight = slideSize.height;
  23. // Let the browser know what page size we want to print
  24. createStyleSheet( '@page{size:'+ pageWidth +'px '+ pageHeight +'px; margin: 0px;}' );
  25. // Limit the size of certain elements to the dimensions of the slide
  26. createStyleSheet( '.reveal section>img, .reveal section>video, .reveal section>iframe{max-width: '+ slideWidth +'px; max-height:'+ slideHeight +'px}' );
  27. document.documentElement.classList.add( 'print-pdf' );
  28. document.body.style.width = pageWidth + 'px';
  29. document.body.style.height = pageHeight + 'px';
  30. // Make sure stretch elements fit on slide
  31. this.Reveal.layoutSlideContents( slideWidth, slideHeight );
  32. const slides = queryAll( this.Reveal.getRevealElement(), SLIDES_SELECTOR )
  33. // Compute slide numbers now, before we start duplicating slides
  34. let doingSlideNumbers = config.slideNumber && /all|print/i.test( config.showSlideNumber );
  35. // Batch scrollHeight access to prevent layout thrashing
  36. await new Promise(requestAnimationFrame);
  37. const slideScrollHeights = []
  38. slides.forEach( function( slide ) {
  39. slideScrollHeights.push( slide.scrollHeight );
  40. });
  41. // Slide and slide background layout
  42. slides.forEach( function( slide, index ) {
  43. // Vertical stacks are not centred since their section
  44. // children will be
  45. if( slide.classList.contains( 'stack' ) === false ) {
  46. // Center the slide inside of the page, giving the slide some margin
  47. let left = ( pageWidth - slideWidth ) / 2,
  48. top = ( pageHeight - slideHeight ) / 2;
  49. const contentHeight = slideScrollHeights[ index ];
  50. let numberOfPages = Math.max( Math.ceil( contentHeight / pageHeight ), 1 );
  51. // Adhere to configured pages per slide limit
  52. numberOfPages = Math.min( numberOfPages, config.pdfMaxPagesPerSlide );
  53. // Center slides vertically
  54. if( numberOfPages === 1 && config.center || slide.classList.contains( 'center' ) ) {
  55. top = Math.max( ( pageHeight - contentHeight ) / 2, 0 );
  56. }
  57. // Wrap the slide in a page element and hide its overflow
  58. // so that no page ever flows onto another
  59. let page = document.createElement( 'div' );
  60. page.className = 'pdf-page';
  61. page.style.height = ( ( pageHeight + config.pdfPageHeightOffset ) * numberOfPages ) + 'px';
  62. slide.parentNode.insertBefore( page, slide );
  63. page.appendChild( slide );
  64. // Position the slide inside of the page
  65. slide.style.left = left + 'px';
  66. slide.style.top = top + 'px';
  67. slide.style.width = slideWidth + 'px';
  68. if( slide.slideBackgroundElement ) {
  69. page.insertBefore( slide.slideBackgroundElement, slide );
  70. }
  71. // Inject notes if `showNotes` is enabled
  72. if( config.showNotes ) {
  73. // Are there notes for this slide?
  74. let notes = this.Reveal.getSlideNotes( slide );
  75. if( notes ) {
  76. let notesSpacing = 8;
  77. let notesLayout = typeof config.showNotes === 'string' ? config.showNotes : 'inline';
  78. let notesElement = document.createElement( 'div' );
  79. notesElement.classList.add( 'speaker-notes' );
  80. notesElement.classList.add( 'speaker-notes-pdf' );
  81. notesElement.setAttribute( 'data-layout', notesLayout );
  82. notesElement.innerHTML = notes;
  83. if( notesLayout === 'separate-page' ) {
  84. page.parentNode.insertBefore( notesElement, page.nextSibling );
  85. }
  86. else {
  87. notesElement.style.left = notesSpacing + 'px';
  88. notesElement.style.bottom = notesSpacing + 'px';
  89. notesElement.style.width = ( pageWidth - notesSpacing*2 ) + 'px';
  90. page.appendChild( notesElement );
  91. }
  92. }
  93. }
  94. // Inject slide numbers if `slideNumbers` are enabled
  95. if( doingSlideNumbers ) {
  96. const slideNumber = index + 1;
  97. const numberElement = document.createElement( 'div' );
  98. numberElement.classList.add( 'slide-number' );
  99. numberElement.classList.add( 'slide-number-pdf' );
  100. numberElement.innerHTML = slideNumber;
  101. page.appendChild( numberElement );
  102. }
  103. // Copy page and show fragments one after another
  104. if( config.pdfSeparateFragments ) {
  105. // Each fragment 'group' is an array containing one or more
  106. // fragments. Multiple fragments that appear at the same time
  107. // are part of the same group.
  108. let fragmentGroups = this.Reveal.fragments.sort( page.querySelectorAll( '.fragment' ), true );
  109. let previousFragmentStep;
  110. let previousPage;
  111. fragmentGroups.forEach( function( fragments ) {
  112. // Remove 'current-fragment' from the previous group
  113. if( previousFragmentStep ) {
  114. previousFragmentStep.forEach( function( fragment ) {
  115. fragment.classList.remove( 'current-fragment' );
  116. } );
  117. }
  118. // Show the fragments for the current index
  119. fragments.forEach( function( fragment ) {
  120. fragment.classList.add( 'visible', 'current-fragment' );
  121. }, this );
  122. // Create a separate page for the current fragment state
  123. let clonedPage = page.cloneNode( true );
  124. page.parentNode.insertBefore( clonedPage, ( previousPage || page ).nextSibling );
  125. previousFragmentStep = fragments;
  126. previousPage = clonedPage;
  127. }, this );
  128. // Reset the first/original page so that all fragments are hidden
  129. fragmentGroups.forEach( function( fragments ) {
  130. fragments.forEach( function( fragment ) {
  131. fragment.classList.remove( 'visible', 'current-fragment' );
  132. } );
  133. } );
  134. }
  135. // Show all fragments
  136. else {
  137. queryAll( page, '.fragment:not(.fade-out)' ).forEach( function( fragment ) {
  138. fragment.classList.add( 'visible' );
  139. } );
  140. }
  141. }
  142. }, this );
  143. // Notify subscribers that the PDF layout is good to go
  144. this.Reveal.dispatchEvent({ type: 'pdf-ready' });
  145. }
  146. /**
  147. * Checks if this instance is being used to print a PDF.
  148. */
  149. isPrintingPDF() {
  150. return ( /print-pdf/gi ).test( window.location.search );
  151. }
  152. }