diff options
author | 2023-08-25 14:43:52 +0200 | |
---|---|---|
committer | 2023-08-25 08:43:52 -0400 | |
commit | acf652fc1d5db166231e87e22d0d50444f5556d8 (patch) | |
tree | 95f80b04a9c6cb208433f403558d11671ce56031 | |
parent | a35c21cfc8e6074a8effd0529dd6e852bbd769a6 (diff) | |
download | astro-acf652fc1d5db166231e87e22d0d50444f5556d8.tar.gz astro-acf652fc1d5db166231e87e22d0d50444f5556d8.tar.zst astro-acf652fc1d5db166231e87e22d0d50444f5556d8.zip |
feat(ViewTransitions): use `scrollend` instead of `scroll` where supported (#8156)
* feat(ViewTransitions): use `scrollend` instead of `scroll` where supported
The [scrollend](https://developer.chrome.com/blog/scrollend-a-new-javascript-event/#event-details) mechanism seems like a better way to record the scroll position compared to throttling, so we could use it whenever a browser supports it.
Additionally, I've removed the `{passive}` flag from the `scroll` event, as it does nothing ([source](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener?retiredLocale=de#improving_scrolling_performance_with_passive_listeners:~:text=You%20don%27t%20need%20to%20worry%20about%20the%20value%20of%20passive%20for%20the%20basic%20scroll%20event.%20Since%20it%20can%27t%20be%20canceled%2C%20event%20listeners%20can%27t%20block%20page%20rendering%20anyway.)).
* Create long-chefs-jump.md
* fix typo / update comment
-rw-r--r-- | .changeset/long-chefs-jump.md | 5 | ||||
-rw-r--r-- | packages/astro/components/ViewTransitions.astro | 22 |
2 files changed, 15 insertions, 12 deletions
diff --git a/.changeset/long-chefs-jump.md b/.changeset/long-chefs-jump.md new file mode 100644 index 000000000..ed8f47614 --- /dev/null +++ b/.changeset/long-chefs-jump.md @@ -0,0 +1,5 @@ +--- +'astro': patch +--- + +The scrollend mechanism is a better way to record the scroll position compared to throttling, so we now use it whenever a browser supports it.
\ No newline at end of file diff --git a/packages/astro/components/ViewTransitions.astro b/packages/astro/components/ViewTransitions.astro index 42e8deb74..7fa336768 100644 --- a/packages/astro/components/ViewTransitions.astro +++ b/packages/astro/components/ViewTransitions.astro @@ -385,17 +385,15 @@ const { fallback = 'animate' } = Astro.props as Props; }); addEventListener('load', onPageLoad); // There's not a good way to record scroll position before a back button. - // So the way we do it is by listening to scroll and just continuously recording it. - addEventListener( - 'scroll', - throttle(() => { - // only updste history entries that are managed by us - // leave other entries alone and do not accidently add state. - if (history.state) { - persistState({ ...history.state, scrollY }); - } - }, 300), - { passive: true } - ); + // So the way we do it is by listening to scrollend if supported, and if not continuously record the scroll position. + const updateState = () => { + // only update history entries that are managed by us + // leave other entries alone and do not accidently add state. + if (history.state) { + persistState({ ...history.state, scrollY }); + } + } + if ('onscrollend' in window) addEventListener('scrollend', updateState); + else addEventListener('scroll', throttle(updateState, 300)); } </script> |