Make impressConsole.js a self contained impress.js plugin #22
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This patch makes necessary changes to adhere to the new impress.js plugin api, as described here: https://github.com/henrikingo/impress.js/blob/myfork/src/plugins/README.md See #19 for a thorough discussion on what that means for impressConsole in particular. This patch implements the changes described in that issue. Even if you don't care about such a plugin api, this introduces the following enhancements for any user of impress-console: * impressConsole will now call init() on itself automatically when you call impress().init(). This means you only need to include impressConsole.js file with a <script>, and it will work out of the box. * The default css is inlined into impressConsole.js. This means that impressConsole.js is now a self contained file and doesn't depend on any other file (e.g. the css files) for working. * All changes are backward compatible. For example, you can still call `impressConsole().init('css/impressConsoleDark.css')` if you want.
henrikingo
commented
Oct 28, 2016
| @@ -74,10 +76,12 @@ | |||
| '</body></html>'; | |||
|
|
|||
| // Default css location | |||
| var cssFile = "css/impressConsole.css"; | |||
| var cssFileOldDefault = "css/impressConsole.css"; | |||
There was a problem hiding this comment.
The old default is simply used in the new init() to compare and possibly print a deprecation message.
henrikingo
commented
Oct 28, 2016
| @@ -324,7 +342,7 @@ | |||
| // Add clock tick | |||
| consoleWindow.timerStart = new Date(); | |||
| consoleWindow.timerReset = timerReset; | |||
| consoleWindow.clockInterval = setInterval('impressConsole("' + rootId + '").clockTick()', 1000 ); | |||
| consoleWindow.clockInterval = setInterval(allConsoles[rootId].clockTick, 1000 ); | |||
There was a problem hiding this comment.
This doesn't change anything, but internally there is now no dependency on calling window.impressConsole(). Hypothetically in a distant future such a global object could be removed (but there's no pressing need to actually do so).
henrikingo
commented
Oct 28, 2016
|
|
||
| // Returns a string to be used inline as a css <style> element in the console window. | ||
| // Apologies for length, but hiding it here at the end to keep it away from rest of the code. | ||
| var cssStyleStr = function(){ |
There was a problem hiding this comment.
There was much more CSS than I had realized when I proposed this change. Let me know if you feel bad about this. Still, upon reflection, I felt that inlining this default css has the benefit that you only need impressConsole.js somewhere, and don't need any other files and don't even need to call impress().init() at all to use the console, it's initialized automatically.
henrikingo
commented
Oct 28, 2016
| // Returns a string to be used inline as a css <style> element in the console window. | ||
| // Apologies for length, but hiding it here at the end to keep it away from rest of the code. | ||
| var cssStyleStr = function(){ | ||
| return `<style> |
There was a problem hiding this comment.
EcmaScript 6 introduced template string syntax, which can also be used for multiline strings. I figured since the policy in impress.js is to only target newest borwsers anyway, it is ok to use it. If you disagree, I'm happy to change to
'...' +
'...' + etc...
henrikingo
added a commit
to henrikingo/impress.js
that referenced
this pull request
May 1, 2017
Also applies this pull request, which makes this possible: regebro/impress-console#22
henrikingo
pushed a commit
to henrikingo/impress.js
that referenced
this pull request
Oct 23, 2017
Press 'P' to show a speaker console in a separate window. Supports: - Navigation controls - This slide and next slide preview screens - Speaker notes - Clock and timer Also applies this patch, which makes impressConsole.js follow the new impress.js plugin standard: regebro/impress-console#22 Note: As impressConsole is now a plugin, it is included by default. You no longer need to include it with a separate <script> tag. Nor do you need to call its init() method.
henrikingo
pushed a commit
to impress/impress.js
that referenced
this pull request
Oct 30, 2017
Press 'P' to show a speaker console in a separate window. Supports: - Navigation controls - This slide and next slide preview screens - Speaker notes - Clock and timer Also applies this patch, which makes impressConsole.js follow the new impress.js plugin standard: regebro/impress-console#22 Note: As impressConsole is now a plugin, it is included by default. You no longer need to include it with a separate <script> tag. Nor do you need to call its init() method.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch makes necessary changes to adhere to the new impress.js
plugin api, as described here:
https://github.com/henrikingo/impress.js/blob/myfork/src/plugins/README.md
See #19 for a thorough
discussion on what that means for impressConsole in particular. This
patch implements the changes described in that issue.
Even if you don't care about such a plugin api, this introduces the following
enhancements for any user of impress-console:
you call impress().init(). This means you only need to include
impressConsole.js file with a <script>, and it will work out of
the box.
impressConsole.js is now a self contained file and doesn't depend
on any other file (e.g. the css files) for working.
impressConsole().init('css/impressConsoleDark.css')if you want.