Skip to content
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.

Sign up for GitHub

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

Hide buttons generated by the TryExamples directive by default #173

Draft
wants to merge 13 commits into
base: main
Choose a base branch
from
Draft

Hide buttons generated by the TryExamples directive by default #173

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
1b798e5
Ignore VS Code folder
agriyakhetarpal Apr 29, 2024
37fa0ca
Set `hidden` to `try_examples_button` classes
agriyakhetarpal May 1, 2024
09d48ab
Un-hide TryExamples buttons based on regex
agriyakhetarpal May 1, 2024
2d46d7f
Fix incorrect regex check
agriyakhetarpal May 1, 2024
0e88cbf
Revert "Fix incorrect regex check"
agriyakhetarpal May 2, 2024
d2811f9
Revert "Ignore VS Code folder"
agriyakhetarpal May 2, 2024
0745252
Update `toggleTryExamplesButtons` function too
agriyakhetarpal May 2, 2024
a9c73ba
Update logic for `tryExamplesConfigLoaded`
agriyakhetarpal May 2, 2024
94ecef4
Merge branch 'main' into make-buttons-hidden-by-default
agriyakhetarpal Jul 22, 2024
d015b5f
Add note about "hidden" class for TryExamples buttons
agriyakhetarpal Dec 3, 2024
635a3af
Refactor + fade examples buttons into the screen
agriyakhetarpal Dec 3, 2024
33b9f4e
Merge branch 'main' into make-buttons-hidden-by-default
agriyakhetarpal Dec 3, 2024
f3ca349
Add smooth transitions
agriyakhetarpal Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ docs/build
build
dist
.jupyterlite.doit.db
/.vscode/
agriyakhetarpal marked this conversation as resolved.
Show resolved Hide resolved
11 changes: 7 additions & 4 deletions jupyterlite_sphinx/jupyterlite_sphinx.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,15 +180,18 @@ window.loadTryExamplesConfig = async (configFilePath) => {
tryExamplesGlobalMinHeight = parseInt(data.global_min_height);
}

// Disable interactive examples if file matches one of the ignore patterns
// by hiding try_examples_buttons.
// Selectively enable interactive examples if file matches one of the ignore patterns
// by un-hiding try_examples_buttons.
Patterns = data.ignore_patterns;
for (let pattern of Patterns) {
let regex = new RegExp(pattern);
if (regex.test(currentPageUrl)) {
agriyakhetarpal marked this conversation as resolved.
Show resolved Hide resolved
var buttons = document.getElementsByClassName("try_examples_button");
var buttons = document.getElementsByClassName(
"try_examples_button hidden",
);
for (var i = 0; i < buttons.length; i++) {
buttons[i].classList.add("hidden");
console.log(buttons[i]);
buttons[i].classList.remove("hidden");
}
break;
}
Expand Down
6 changes: 3 additions & 3 deletions jupyterlite_sphinx/jupyterlite_sphinx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -468,14 +468,14 @@ def run(self):

# Button with the onclick event to swap embedded notebook back to examples.
go_back_button_html = (
'<button class="try_examples_button" '
'<button class="try_examples_button hidden" '
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From what I can tell, these buttons are already within a .hidden container.

Suggested change
'<button class="try_examples_button hidden" '
'<button class="try_examples_button" '

f"onclick=\"window.tryExamplesHideIframe('{examples_div_id}',"
f"'{iframe_parent_div_id}')\">"
"Go Back</button>"
)

full_screen_button_html = (
'<button class="try_examples_button" '
'<button class="try_examples_button hidden" '
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'<button class="try_examples_button hidden" '
'<button class="try_examples_button" '

f"onclick=\"window.openInNewTab('{examples_div_id}',"
f"'{iframe_parent_div_id}')\">"
"Open In Tab</button>"
Expand All @@ -484,7 +484,7 @@ def run(self):
# Button with the onclick event to swap examples with embedded notebook.
try_it_button_html = (
'<div class="try_examples_button_container">'
'<button class="try_examples_button" '
'<button class="try_examples_button hidden" '
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'<button class="try_examples_button hidden" '
'<button class="try_examples_button hidden transparent" '

(see other suggestions above)

f"onclick=\"window.tryExamplesShowIframe('{examples_div_id}',"
f"'{iframe_div_id}','{iframe_parent_div_id}','{iframe_src}',"
f"'{height}')\">"
Expand Down
Loading