notes.js 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  1. /**
  2. * Handles opening of and synchronization with the reveal.js
  3. * notes window.
  4. *
  5. * Handshake process:
  6. * 1. This window posts 'connect' to notes window
  7. * - Includes URL of presentation to show
  8. * 2. Notes window responds with 'connected' when it is available
  9. * 3. This window proceeds to send the current presentation state
  10. * to the notes window
  11. */
  12. var RevealNotes = (function() {
  13. function openNotes( notesFilePath ) {
  14. if( !notesFilePath ) {
  15. var jsFileLocation = document.querySelector('script[src$="notes.js"]').src; // this js file path
  16. jsFileLocation = jsFileLocation.replace(/notes\.js(\?.*)?$/, ''); // the js folder path
  17. notesFilePath = jsFileLocation + 'notes.html';
  18. }
  19. var notesPopup = window.open( notesFilePath, 'reveal.js - Notes', 'width=1100,height=700' );
  20. /**
  21. * Connect to the notes window through a postmessage handshake.
  22. * Using postmessage enables us to work in situations where the
  23. * origins differ, such as a presentation being opened from the
  24. * file system.
  25. */
  26. function connect() {
  27. // Keep trying to connect until we get a 'connected' message back
  28. var connectInterval = setInterval( function() {
  29. notesPopup.postMessage( JSON.stringify( {
  30. namespace: 'reveal-notes',
  31. type: 'connect',
  32. url: window.location.protocol + '//' + window.location.host + window.location.pathname + window.location.search,
  33. state: Reveal.getState()
  34. } ), '*' );
  35. }, 500 );
  36. window.addEventListener( 'message', function( event ) {
  37. var data = JSON.parse( event.data );
  38. if( data && data.namespace === 'reveal-notes' && data.type === 'connected' ) {
  39. clearInterval( connectInterval );
  40. onConnected();
  41. }
  42. if( data && data.namespace === 'reveal-notes' && data.type === 'call' ) {
  43. callRevealApi( data.methodName, data.arguments, data.callId );
  44. }
  45. } );
  46. }
  47. function callRevealApi( methodName, methodArguments, callId ) {
  48. var result = Reveal[methodName].call(Reveal, methodArguments);
  49. notesPopup.postMessage( JSON.stringify( {
  50. namespace: 'reveal-notes',
  51. type: 'return',
  52. result: result,
  53. callId: callId
  54. } ), '*' );
  55. }
  56. /**
  57. * Posts the current slide data to the notes window
  58. */
  59. function post( event ) {
  60. var slideElement = Reveal.getCurrentSlide(),
  61. notesElement = slideElement.querySelector( 'aside.notes' ),
  62. fragmentElement = slideElement.querySelector( '.current-fragment' );
  63. var messageData = {
  64. namespace: 'reveal-notes',
  65. type: 'state',
  66. notes: '',
  67. markdown: false,
  68. whitespace: 'normal',
  69. state: Reveal.getState()
  70. };
  71. // Look for notes defined in a slide attribute
  72. if( slideElement.hasAttribute( 'data-notes' ) ) {
  73. messageData.notes = slideElement.getAttribute( 'data-notes' );
  74. messageData.whitespace = 'pre-wrap';
  75. }
  76. // Look for notes defined in a fragment
  77. if( fragmentElement ) {
  78. var fragmentNotes = fragmentElement.querySelector( 'aside.notes' );
  79. if( fragmentNotes ) {
  80. notesElement = fragmentNotes;
  81. }
  82. else if( fragmentElement.hasAttribute( 'data-notes' ) ) {
  83. messageData.notes = fragmentElement.getAttribute( 'data-notes' );
  84. messageData.whitespace = 'pre-wrap';
  85. // In case there are slide notes
  86. notesElement = null;
  87. }
  88. }
  89. // Look for notes defined in an aside element
  90. if( notesElement ) {
  91. messageData.notes = notesElement.innerHTML;
  92. messageData.markdown = typeof notesElement.getAttribute( 'data-markdown' ) === 'string';
  93. }
  94. notesPopup.postMessage( JSON.stringify( messageData ), '*' );
  95. }
  96. /**
  97. * Called once we have established a connection to the notes
  98. * window.
  99. */
  100. function onConnected() {
  101. // Monitor events that trigger a change in state
  102. Reveal.addEventListener( 'slidechanged', post );
  103. Reveal.addEventListener( 'fragmentshown', post );
  104. Reveal.addEventListener( 'fragmenthidden', post );
  105. Reveal.addEventListener( 'overviewhidden', post );
  106. Reveal.addEventListener( 'overviewshown', post );
  107. Reveal.addEventListener( 'paused', post );
  108. Reveal.addEventListener( 'resumed', post );
  109. // Post the initial state
  110. post();
  111. }
  112. connect();
  113. }
  114. if( !/receiver/i.test( window.location.search ) ) {
  115. // If the there's a 'notes' query set, open directly
  116. if( window.location.search.match( /(\?|\&)notes/gi ) !== null ) {
  117. openNotes();
  118. }
  119. // Open the notes when the 's' key is hit
  120. Reveal.addKeyBinding({keyCode: 83, key: 'S', description: 'Speaker notes view'}, function() {
  121. openNotes();
  122. } );
  123. }
  124. return { open: openNotes };
  125. })();