Hydration error while using "useGsap" and "ScrollTrigger" in next.js

[Dealu]

"use client";

 

import React, { useRef } from "react";

 

// Types

import type { NavbarProps } from "./types";

 

// Images

import { DesignWhizLogo } from "../svg/svg";

 

// Imports

import clsx from "clsx";

import gsap from "gsap";

import { useGSAP } from "@gsap/react";

import NavbarLinks from "./navbar-links";

import { NavbarCTA } from "./navbar-components";

import { ScrollTrigger } from "gsap/all";

 

gsap.registerPlugin(useGSAP, ScrollTrigger);

 

const Navbar: React.FC<NavbarProps> = ({ className }) => {

  const navbarRef = useRef<HTMLDivElement>(null);

 

  useGSAP(() => {

    ScrollTrigger.create({

      trigger: "#navbar-trigger",

      start: "top top",

      animation: gsap.to(navbarRef.current, {

        width: "auto",

      }),

      toggleActions: "play none reverse none",

    });

  });

 

  return (

    <header

      ref={navbarRef}
    // ... remaining code is irrelevant, hopefully 😊

[Dealu]

Just now, Dealu said:

"use client";

 

import React, { useRef } from "react";

 

// Types

import type { NavbarProps } from "./types";

 

// Images

import { DesignWhizLogo } from "../svg/svg";

 

// Imports

import clsx from "clsx";

import gsap from "gsap";

import { useGSAP } from "@gsap/react";

import NavbarLinks from "./navbar-links";

import { NavbarCTA } from "./navbar-components";

import { ScrollTrigger } from "gsap/all";

 

gsap.registerPlugin(useGSAP, ScrollTrigger);

 

const Navbar: React.FC<NavbarProps> = ({ className }) => {

  const navbarRef = useRef<HTMLDivElement>(null);

 

  useGSAP(() => {

    ScrollTrigger.create({

      trigger: "#navbar-trigger",

      start: "top top",

      animation: gsap.to(navbarRef.current, {

        width: "auto",

      }),

      toggleActions: "play none reverse none",

    });

  });

 

  return (

    <header

      ref={navbarRef}
    // ... remaining code is irrelevant, hopefully 😊

Please help me 😭

[GSAP Helper]

Without a minimal demo, it's very difficult to troubleshoot; the issue could be caused by CSS, markup, a third party library, a 3rd party script, etc. Would you please provide a very simple CodePen or Stackblitz that illustrates the issue? 

 

I'd strongly suggest only running the GSAP-related code in the browser (not server-side). 

 

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

 

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

that loads all the plugins. Just click "fork" at the bottom right and make your minimal demo: 

 

Using a framework/library like React, Vue, Next, etc.? 

CodePen isn't always ideal for these tools, so here are some Stackblitz starter templates that you can fork and import the gsap-trial NPM package for using any of the bonus plugins: 

• React (please read this article!)
• Next
• Svelte
• Sveltekit
• Vue
• Nuxt

 

Please share the StackBlitz link directly to the file in question (where you've put the GSAP code) so we don't need to hunt through all the files. 

 

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

[Rodrigo]

Hi,

 

In Next is better to check if you're on the server or the browser before registering the Plugins, just check for the window object and that should help:

import gsap from "gsap";
import { ScrollTrigger } from "gsap/ScrollTrigger";
import { useGSAP } from "@gsap/react";

if (typeof window !== "undefined") {
  gsap.registerPlugin(ScrollTrigger, useGSAP);
}

Another option since normally registering our useGSAP hook is not always necessary, you can register the plugins inside of it:

import gsap from "gsap";
import { ScrollTrigger } from "gsap/ScrollTrigger";
import { useGSAP } from "@gsap/react";

export function MyComponent() {
  useGSAP(() => {
    gsap.registerPlugin(ScrollTrigger);
  });
  
  return (
    //...
  );
};

Hopefully this helps

Happy Tweening!