ScrollTrigger ignore history.scrollRestoration manual

[Basilico 6 Likes (Newbie)]

Hi,

Scrolltrigger version 3.11.3 (and probably older versions too) save the history.scrollRestoration value at the beginning and it seems it's not possibile to overwrite that value later:

 

_scrollRestoration = _win.history.scrollRestoration || "auto";

Then the stored value is applied again every clearScrollMemory call:

 

_isString(scrollRestoration) && (_win.history.scrollRestoration = _scrollRestoration = scrollRestoration);

 

Even setting history.scrollRestoration to manual at the beginning of my script, due to Webpack bundle, the Scrolltrigger code is extecuted before mine.

 

In my case I need to set the scrollRestoration to manual because I use Barba.js

 

Is there a way to do it? Am I missing something?

 

 

[GSAP Helper 97 Likes (Contributor)]

It's pretty tough to troubleshoot without a minimal demo - the issue could be caused by CSS, markup, a third party library, your browser, an external script that's totally unrelated to GSAP, etc. Would you please provide a very simple CodePen or CodeSandbox that demonstrates the issue? 

 

Please don't include your whole project. Just some colored <div> elements and the GSAP code is best (avoid frameworks if possible). See if you can recreate the issue with as few dependancies as possible. If not, incrementally add code bit by bit until it breaks. Usually people solve their own issues during this process! If not, then at least we have a reduced test case which greatly increases your chances of getting a relevant answer.

 

Here's a starter CodePen that loads all the plugins. Just click "fork" at the bottom right and make your minimal demo: 

See the Pen aYYOdN by GreenSock (@GreenSock) on CodePen

 

If you're using something like React/Next/Nuxt/Gatsby or some other framework, you may find CodeSandbox easier to use. 

 

Once we see an isolated demo, we'll do our best to jump in and help with your GSAP-specific questions. 

[Basilico 6 Likes (Newbie)]

Here's the demo:

 

See the Pen gOKmJRR by fnool (@fnool) on CodePen

[GreenSock 18,587 Likes (Superhero)]

Sure, you can set it like this: 

ScrollTrigger.clearScrollMemory('manual');

 

[Basilico 6 Likes (Newbie)]

Thanks, you're right. Calling the method like that it stores a new value.

This means that I have to call ScrollTrigger.clearScrollMemory('manual');at the beginning of my code to store the right value.

Probably the documentation needs to explain this feature better, because in my project I didn't  think I need to call that method but now I found I need it to save the value.

Unless this sentence in the doc: 

Quote

Normally, this isn't necessary but in some frameworks that handle routing in unconventional ways, it can be useful.

is valid also for Barba.js page transitions. 

Do you suggest to call that method every page transition?

Thanks.

[GreenSock 18,587 Likes (Superhero)]

18 hours ago, Basilico said:

Do you suggest to call that method every page transition?

That certainly wouldn't hurt, but it's only necessary once when ScrollTrigger loads. If you're not flushing the entire page (including ScrollTrigger), it shouldn't be necessary.