-
Notifications
You must be signed in to change notification settings - Fork 7
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
Fix Scrollama problems on browser resize/zoom #107
Merged
Merged
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
276bc3e
Changing browser zoom breaks Scrollama progress updates
ed79c9c
Improve overlay narrative positioning
bccd41f
Add scale-to-fill to index page code block
7a3151a
Lower font size of code block
448885c
Reduce sticky col font size
bcfcc66
move second hotkey listener inside the on-documentload condition to p…
andrewpbray 96a4bb0
Remove commented out throttle-debounce import
jimjam-slam 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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 |
|---|---|---|
|
|
@@ -2,6 +2,8 @@ | |
| // closeread.js // | ||
| //==============// | ||
|
|
||
| // import throttleDebounce from "https://cdn.jsdelivr.net/npm/[email protected]/+esm" | ||
|
|
||
| // set params | ||
| const triggerSelector = '.new-trigger' | ||
| const progressBlockSelector = '.progress-block' | ||
|
|
@@ -58,101 +60,109 @@ document.addEventListener("DOMContentLoaded", () => { | |
| // collect all sticky elements | ||
| const allStickies = Array.from(document.querySelectorAll(".sticky")); | ||
|
|
||
|
|
||
| // === Set up scrolling event listeners === // | ||
| // scrollama() is accessible because scrollama.min.js is attached via closeread.lua | ||
| // scrollama() is accessible because scrollama.min.js is attached | ||
| // via closeread.lua | ||
| const triggerScrollerConfig = { | ||
jimjam-slam marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| step: triggerSelector, | ||
| offset: 0.5, | ||
| progress: true, | ||
| debug: debugMode | ||
| } | ||
| const progressScrollerConfig = { | ||
| step: progressBlockSelector, | ||
| offset: 0.5, | ||
| progress: true, | ||
| debug: debugMode | ||
| } | ||
|
|
||
| function crTriggerStepEnter(trigger) { | ||
| focusedStickyName = trigger.element.getAttribute("data-focus-on") | ||
|
|
||
| // update ojs variables | ||
| ojsTriggerIndex?.define("crTriggerIndex", trigger.index) | ||
| ojsStickyName?.define("crActiveSticky", focusedStickyName) | ||
|
|
||
| updateStickies(allStickies, focusedStickyName, trigger) | ||
| } | ||
|
|
||
| function crTriggerStepProgress(trigger) { | ||
| ojsTriggerProgress?.define("crTriggerProgress", trigger.progress) | ||
| ojsDirection?.define("crDirection", trigger.direction) | ||
| } | ||
|
|
||
| function crProgressStepEnter(progressBlock) { | ||
| ojsProgressBlock?.define("crProgressBlock", progressBlock.progress) | ||
| } | ||
|
|
||
| // set up scrollers on document load, and reset them when window zoom changes | ||
| // (they seem to misbehave on zoom change: see issue #101) | ||
|
|
||
| // primary scroller | ||
| const triggerScroller = scrollama(); | ||
| const triggerScroller = scrollama() | ||
| triggerScroller | ||
| .setup({ | ||
| step: triggerSelector, | ||
| offset: 0.5, | ||
| progress: true, | ||
| debug: debugMode | ||
| }) | ||
| .onStepEnter((trigger) => { | ||
|
|
||
| focusedStickyName = trigger.element.getAttribute("data-focus-on"); | ||
|
|
||
| // update ojs variables | ||
| ojsTriggerIndex?.define("crTriggerIndex", trigger.index); | ||
| ojsStickyName?.define("crActiveSticky", focusedStickyName); | ||
|
|
||
| updateStickies(allStickies, focusedStickyName, trigger); | ||
|
|
||
| }) | ||
| .onStepProgress((trigger) => { | ||
|
|
||
| // update ojs variables | ||
| ojsTriggerProgress?.define("crTriggerProgress", trigger.progress); | ||
| ojsDirection?.define("crDirection", trigger.direction); | ||
|
|
||
| }); | ||
| .setup(triggerScrollerConfig) | ||
| .onStepEnter(crTriggerStepEnter) | ||
| .onStepProgress(crTriggerStepProgress) | ||
|
|
||
| // secondary scroller used for making progress blocks | ||
| const progressBlockScroller = scrollama(); | ||
| progressBlockScroller | ||
| .setup({ | ||
| step: progressBlockSelector, | ||
| offset: 0.5, | ||
| progress: true, | ||
| debug: debugMode | ||
| }) | ||
| .onStepProgress((progressBlock) => { | ||
| // update ojs variable | ||
| ojsProgressBlock?.define("crProgressBlock", progressBlock.progress); | ||
| }); | ||
| // secondary scroller used for making progress blocks | ||
| const progressBlockScroller = scrollama() | ||
| progressBlockScroller | ||
| .setup(progressScrollerConfig) | ||
| .onStepProgress(crProgressStepEnter) | ||
|
|
||
| window.addEventListener("resize", (event) => { | ||
| setTimeout(() => triggerScroller.resize(), 1000) | ||
| setTimeout(() => progressBlockScroller.resize(), 1000) | ||
| }) | ||
|
|
||
| // === Hotkey Listeners === // | ||
| // Add a listener for scrolling between new triggers | ||
| let currentIndex = -1; // Start before the first element | ||
|
|
||
| function scrollToNewTrigger(direction) { | ||
| const triggers = document.querySelectorAll('.new-trigger'); | ||
|
|
||
| // Add a listener for scrolling between new triggers | ||
| let currentIndex = -1; // Start before the first element | ||
| if (triggers.length === 0) return; // do nothing if there's no triggers | ||
|
|
||
| function scrollToNewTrigger(direction) { | ||
| const triggers = document.querySelectorAll('.new-trigger'); | ||
|
|
||
| if (triggers.length === 0) return; // do nothing if there's no triggers | ||
|
|
||
| if (direction === "next") { | ||
| if (currentIndex >= triggers.length - 1) return; // exit if at end | ||
| currentIndex += 1; | ||
| } | ||
|
|
||
| if (direction === "previous") { | ||
| if (currentIndex === 0) return; // exit if at start | ||
| currentIndex -= 1; | ||
| } | ||
|
|
||
| const nextTrigger = triggers[currentIndex]; | ||
| nextTrigger.scrollIntoView({ behavior: 'smooth', block: 'center' }); | ||
| if (direction === "next") { | ||
| if (currentIndex >= triggers.length - 1) return; // exit if at end | ||
| currentIndex += 1; | ||
| } | ||
|
|
||
| document.addEventListener('keydown', (event) => { | ||
| if (event.key === 'ArrowRight') { | ||
| scrollToNewTrigger("next"); | ||
| } | ||
| if (event.key === 'ArrowLeft') { | ||
| scrollToNewTrigger("previous"); | ||
| } | ||
| }); | ||
| if (direction === "previous") { | ||
| if (currentIndex === 0) return; // exit if at start | ||
| currentIndex -= 1; | ||
| } | ||
|
|
||
| const nextTrigger = triggers[currentIndex]; | ||
| nextTrigger.scrollIntoView({ behavior: 'smooth', block: 'center' }); | ||
| } | ||
|
|
||
| document.addEventListener('keydown', (event) => { | ||
| if (event.key === 'ArrowRight') { | ||
| scrollToNewTrigger("next"); | ||
| } | ||
| if (event.key === 'ArrowLeft') { | ||
| scrollToNewTrigger("previous"); | ||
| } | ||
| }); | ||
|
|
||
| }); | ||
|
|
||
| // === Other Hotkey Listeners === // | ||
|
|
||
| // toggle presentation mode | ||
| document.addEventListener('keydown', (event) => { | ||
| const crSections = document.querySelectorAll('.cr-section'); | ||
| crSections.forEach((el) => { | ||
| if (event.key === "p") { | ||
| if (el.classList.contains("presentation-mode")) { | ||
| el.classList.remove("presentation-mode"); | ||
| } else { | ||
| el.classList.add("presentation-mode"); | ||
| // toggle presentation mode | ||
| document.addEventListener('keydown', (event) => { | ||
| const crSections = document.querySelectorAll('.cr-section'); | ||
| crSections.forEach((el) => { | ||
| if (event.key === "p") { | ||
| if (el.classList.contains("presentation-mode")) { | ||
| el.classList.remove("presentation-mode"); | ||
| } else { | ||
| el.classList.add("presentation-mode"); | ||
| } | ||
| } | ||
| } | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| }); | ||
|
|
||
|
|
||
| //===============// | ||
|
|
@@ -393,4 +403,3 @@ function getBooleanConfig(metaFlag) { | |
| .querySelector("meta[" + metaFlag + "]")?.getAttribute(metaFlag) | ||
| return option === "true" | ||
| } | ||
|
|
||
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 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 |
|---|---|---|
| @@ -1,4 +1,11 @@ | ||
| .cr-section { | ||
| font-size: 1.4em; | ||
| background-color: rgba(39, 128, 227, 1); | ||
| } | ||
| } | ||
|
|
||
| .cr-section .narrative-col { | ||
jimjam-slam marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| font-size: 1.4em; | ||
| } | ||
|
|
||
| .cr-section .sticky-col { | ||
| font-size: 0.6em; | ||
| } | ||
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
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.
I'd originally intended to use this package, but I didn't really want t bite off a bundling toolchain (although we could probably load it via a script tag in the HTML, as we do our existing dependencies). I ended up using the native browser
setTimeout()instead, so this can go (although I could try loading it via script and using debounce, which would prevent.resize()being called multiple times). Not sure there's any noticeable performance impact currently, though. I'll remove this commented out code for now.