How to make a horizontal scroll using Next.JS

[josefirmino 0 Likes (Newbie)]

Hey guys,

I met GSAP today and I was impressed with the quality of animations that it is possible to do, I found an example of how to make the horizontal scroll using vanilla js, someone who has already done it using react can give me an example of how to make this type of animation.

Thank you very much :D

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

[Cassie 5,649 Likes (Superhero)]

Hey there!

 

I'm not certain  you'll find someone who's converted that demo into react. Why don't you give it a go yourself? It sounds like a great way to learn.

Here's our 'getting started' React tutorial
 

And here's a simplified down horizontal scrolling demo

See the Pen xxYpEOo?editors=1100 by GreenSock (@GreenSock) on CodePen

Pop back if you have questions - here's a codesandbox to start you off. 

https://codesandbox.io/s/gsap-bonus-plugins-react-starter-je6ln

 

[josefirmino 0 Likes (Newbie)]

Thanks a lot, I'll try and post the result here

[Cassie 5,649 Likes (Superhero)]

Also I just realised this is in the banner dev forum - is that intentional? I can move it if it's not banner ad related.

[josefirmino 0 Likes (Newbie)]

Please move me, I think I put it wrong

[josefirmino 0 Likes (Newbie)]

I'm not able to reproduce the horizontal scroll effect in nextjs, can anyone help me?

[GSAP Helper 122 Likes (Specialist)]

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. 

[noviedo 36 Likes (Newbie)]

Hey @josefirmino, how is going? I leave here an example from @Cassie but implemented it into the Next.js framework. I hope works for you!. 😀

https://codesandbox.io/s/horizontal-scroll-nextjs-fuog8t?file=/pages/index.js

[Dominic97 0 Likes (Newbie)]

@Cassie @noviedo @GSAP Helper Please is there any library, node modules or something that hinders a gsap animation from working in nextjs. I've been stuck trying this horizontal scroll animation for months still to no avail but when I try this same animation outside my codebase it works perfectly

[GSAP Helper 122 Likes (Specialist)]

No, @Dominic97, but since Next.js is React-based, make sure you're doing proper cleanup. React calls useEffect()/useLayoutEffect() TWICE in strict mode which may cause you to be inadvertently creating multiple/competing animations/ScrollTriggers. See this article: https://greensock.com/react-basics

 

GSAP is completely framework-agnostic. You can use it ANYWHERE that JavaScript runs. 

 

If you still need help, please make sure you provide a minimal demo that clearly illustrates the problem. Here's a Next starter template you can fork.

 

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

[DennisDev 2 Likes (Newbie)]

import React, { useEffect } from "react";
import { gsap } from "gsap";
import { ScrollTrigger } from "gsap/dist/ScrollTrigger";
import styled from "styled-components";

gsap.registerPlugin(ScrollTrigger);

const Container = styled.div`
  display: flex;
  width: 100%;
  height: 100vh;
  overflow-x: hidden;
`;

const Panel = styled.div`
  box-sizing: border-box;
  width: 498px;
  height: 459px;
  background: #fff;
  border-radius: 10px;
  flex: 0 0 auto;
  padding: 20px;
  margin-right: 10px;
`;

export default function IndexPage() {
  useEffect(() => {
    const sections = gsap.utils.toArray(".panel");

    gsap.to(sections, {
      xPercent: -100 * (sections.length - 1),
      ease: "none",
      scrollTrigger: {
        trigger: ".container",
        pin: true,
        invalidateOnRefresh: true,
        anticipatePin: 1,
        scrub: 1.23,
        end: () => "+=" + (document.querySelector(".container") as HTMLElement).offsetWidth,
      },
    });
  }, []);

  return (
    <Container className="container">
      {Array.from({ length: 10 }).map((_, index) => (
        <Panel className="panel" key={index}>
          <h2>Card {index + 1}</h2>
        </Panel>
      ))}
    </Container>
  );
}

I hope this helps I used Next js typescript and style component

[Rodrigo 5,885 Likes (Superhero)]

Hi everyone!

 

@DennisDev, thanks for sharing your solution with the community 💚 There is one comment though about the code you posted: You're not using GSAP Context in your effect hook. We strongly recommend using GSAP Context in react environments to solve the issues that arise due to the double call in the effect hooks since version 18 of React.

https://greensock.com/docs/v3/GSAP/gsap.context()

 

As @DennisDev showed, this shouldn't be a complicated endeavor. I just created a super simple example of this that uses GSAP Context:

https://stackblitz.com/edit/nextjs-qq3fvh?file=pages%2Fscroll.js

 

Hopefully this helps.

Happy Tweening!

[DennisDev 2 Likes (Newbie)]

14 hours ago, Rodrigo said:

Hi everyone!

 

@DennisDev, thanks for sharing your solution with the community 💚 There is one comment though about the code you posted: You're not using GSAP Context in your effect hook. We strongly recommend using GSAP Context in react environments to solve the issues that arise due to the double call in the effect hooks since version 18 of React.

https://greensock.com/docs/v3/GSAP/gsap.context()

 

As @DennisDev showed, this shouldn't be a complicated endeavor. I just created a super simple example of this that uses GSAP Context:

https://stackblitz.com/edit/nextjs-qq3fvh?file=pages%2Fscroll.js

 

Hopefully this helps.

Happy Tweening!

thank you on this but the stack blitz link you provide is broken could you update the link

[Rodrigo 5,885 Likes (Superhero)]

Hi,

 

Here is the updated link:

https://stackblitz.com/edit/nextjs-ep1rbj?file=pages%2Fscroll.js

 

Although it seems that something is up with Stackblitz right now. But I can assure you that the code there works as expected on my local machine, so the code should be a good reference.

 

Happy Tweening!