-
Notifications
You must be signed in to change notification settings - Fork 177
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add RISE-lab plugin for jupyterlab_rise #326
Open
f0k
wants to merge
2
commits into
astefanutti:master
Choose a base branch
from
f0k:rise-lab
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
// Plugin for jupyterlab_rise presentations, based on the generic plugin. | ||
// Slides are advanced by key presses; the deck is over when the URL stays unchanged. | ||
|
||
export const help = | ||
`Exports a jupyterlab_rise presentation by advancing with space key presses and | ||
ending when the part after the # in the URL did not change. To use it, start | ||
"jupyter lab", and call decktape with a URL of the form: | ||
http://server:port/rise/your_path/your_notebook.ipynb?token=your_token`; | ||
|
||
export const create = page => new RISElab(page); | ||
|
||
class RISElab { | ||
constructor(page) { | ||
this.page = page; | ||
this.currentSlide = undefined; | ||
} | ||
|
||
getName() { | ||
return 'RISE-lab'; | ||
} | ||
|
||
isActive() { | ||
return true; | ||
} | ||
|
||
async configure() { | ||
// Wait for the presentation to be fully loaded | ||
await this.page.waitForSelector('.reveal-viewport', { timeout: 30000 }); | ||
await this.page.evaluate(_ => { | ||
// Hide "click here to add a new cell" | ||
const footers = document.getElementsByClassName('jp-Notebook-footer'); | ||
for (var i = 0; i < footers.length; i++) { | ||
footers[i].style.display = 'none'; | ||
} | ||
// Hide help button so we do not need to wait for it to fade | ||
const help_btn = document.getElementById('help-b'); | ||
if (help_btn) { | ||
help_btn.style.display = 'none'; | ||
} | ||
}); | ||
this.currentSlide = await this.currentSlideIndex(); | ||
} | ||
|
||
slideCount() { | ||
return undefined; | ||
} | ||
|
||
async hasNextSlide() { | ||
// We try to advance and check whether the URL changed | ||
await this.page.keyboard.press('Space'); | ||
const nextSlide = await this.currentSlideIndex(); | ||
if (nextSlide != this.currentSlide) { | ||
this.currentSlide = nextSlide; | ||
return true; | ||
} | ||
return false; | ||
} | ||
|
||
nextSlide() { | ||
// We already advanced in hasNextSlide(), nothing to do | ||
} | ||
|
||
async currentSlideIndex() { | ||
// We use the part after the # in the URL as the slide name | ||
const hash = await this.page.evaluate(_ => window.location.hash); | ||
const [, fragment] = hash.match(/^#\/?([^?]*)/) || []; | ||
return fragment; | ||
} | ||
} |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This can break other plugins activation. Would there be a more robust way to detect it's called in a jupyterlab_rise context?
Alternatively, we could exclude the plugin here:
decktape/decktape.js
Line 350 in 6735cec
but I'd rather go with the former approach.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, good point. So this would break automatic plugin selection. I'll check if there is a way to tell whether we are in the correct context without waiting for the presentation to be loaded, but it will take a while until I'll get around to that. If I don't find anything, would it be permissible to do a
waitForSelector
and only return after a not-too-long timeout?