1
0

slidenumber.js 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. import {
  2. SLIDE_NUMBER_FORMAT_CURRENT,
  3. SLIDE_NUMBER_FORMAT_CURRENT_SLASH_TOTAL,
  4. SLIDE_NUMBER_FORMAT_HORIZONTAL_DOT_VERTICAL,
  5. SLIDE_NUMBER_FORMAT_HORIZONTAL_SLASH_VERTICAL
  6. } from "../utils/constants";
  7. /**
  8. * Handles the display of reveal.js' optional slide number.
  9. */
  10. export default class SlideNumber {
  11. constructor( Reveal ) {
  12. this.Reveal = Reveal;
  13. }
  14. render() {
  15. this.element = document.createElement( 'div' );
  16. this.element.className = 'slide-number';
  17. this.Reveal.getRevealElement().appendChild( this.element );
  18. }
  19. /**
  20. * Called when the reveal.js config is updated.
  21. */
  22. configure( config, oldConfig ) {
  23. let slideNumberDisplay = 'none';
  24. if( config.slideNumber && !this.Reveal.isPrintView() ) {
  25. if( config.showSlideNumber === 'all' ) {
  26. slideNumberDisplay = 'block';
  27. }
  28. else if( config.showSlideNumber === 'speaker' && this.Reveal.isSpeakerNotes() ) {
  29. slideNumberDisplay = 'block';
  30. }
  31. }
  32. this.element.style.display = slideNumberDisplay;
  33. }
  34. /**
  35. * Updates the slide number to match the current slide.
  36. */
  37. update() {
  38. // Update slide number if enabled
  39. if( this.Reveal.getConfig().slideNumber && this.element ) {
  40. this.element.innerHTML = this.getSlideNumber();
  41. }
  42. }
  43. /**
  44. * Returns the HTML string corresponding to the current slide
  45. * number, including formatting.
  46. */
  47. getSlideNumber( slide = this.Reveal.getCurrentSlide() ) {
  48. let config = this.Reveal.getConfig();
  49. let value;
  50. let format = SLIDE_NUMBER_FORMAT_HORIZONTAL_DOT_VERTICAL;
  51. if ( typeof config.slideNumber === 'function' ) {
  52. value = config.slideNumber( slide );
  53. } else {
  54. // Check if a custom number format is available
  55. if( typeof config.slideNumber === 'string' ) {
  56. format = config.slideNumber;
  57. }
  58. // If there are ONLY vertical slides in this deck, always use
  59. // a flattened slide number
  60. if( !/c/.test( format ) && this.Reveal.getHorizontalSlides().length === 1 ) {
  61. format = SLIDE_NUMBER_FORMAT_CURRENT;
  62. }
  63. // Offset the current slide number by 1 to make it 1-indexed
  64. let horizontalOffset = slide && slide.dataset.visibility === 'uncounted' ? 0 : 1;
  65. value = [];
  66. switch( format ) {
  67. case SLIDE_NUMBER_FORMAT_CURRENT:
  68. value.push( this.Reveal.getSlidePastCount( slide ) + horizontalOffset );
  69. break;
  70. case SLIDE_NUMBER_FORMAT_CURRENT_SLASH_TOTAL:
  71. value.push( this.Reveal.getSlidePastCount( slide ) + horizontalOffset, '/', this.Reveal.getTotalSlides() );
  72. break;
  73. default:
  74. let indices = this.Reveal.getIndices( slide );
  75. value.push( indices.h + horizontalOffset );
  76. let sep = format === SLIDE_NUMBER_FORMAT_HORIZONTAL_SLASH_VERTICAL ? '/' : '.';
  77. if( this.Reveal.isVerticalSlide( slide ) ) value.push( sep, indices.v + 1 );
  78. }
  79. }
  80. let url = '#' + this.Reveal.location.getHash( slide );
  81. return this.formatNumber( value[0], value[1], value[2], url );
  82. }
  83. /**
  84. * Applies HTML formatting to a slide number before it's
  85. * written to the DOM.
  86. *
  87. * @param {number} a Current slide
  88. * @param {string} delimiter Character to separate slide numbers
  89. * @param {(number|*)} b Total slides
  90. * @param {HTMLElement} [url='#'+locationHash()] The url to link to
  91. * @return {string} HTML string fragment
  92. */
  93. formatNumber( a, delimiter, b, url = '#' + this.Reveal.location.getHash() ) {
  94. if( typeof b === 'number' && !isNaN( b ) ) {
  95. return `<a href="${url}">
  96. <span class="slide-number-a">${a}</span>
  97. <span class="slide-number-delimiter">${delimiter}</span>
  98. <span class="slide-number-b">${b}</span>
  99. </a>`;
  100. }
  101. else {
  102. return `<a href="${url}">
  103. <span class="slide-number-a">${a}</span>
  104. </a>`;
  105. }
  106. }
  107. destroy() {
  108. this.element.remove();
  109. }
  110. }