gsap-trial

GSAP (GreenSock Animation Platform) with Trial Bonus Files

⚠️ DO NOT DEPLOY THESE FILES! ⚠️

This package is only intended for experimentation during development. It contains the public GSAP files plus all bonus plugins which are normally available exclusively to Club GSAP members, including ScrollSmoother, DrawSVG, MorphSVG, SplitText, Inertia, and more. The trial plugins only work locally and on certain approved domains like codesandbox.io, codepen.io, stackblitz.com, and jsfiddle.com. Deploying them elsewhere violates the license and will result in a browser redirect!

Sign up for Club GSAP to get the completely unrestricted files.

No GSAP files (including the trial plugins) implement any tracking whatsoever. No data is collected.

Docs

View the full documentation here, including an installation guide.

Usage on approved domains

On a whitelisted domain like codesandbox.io, you can do this:

// typical import
import gsap from "gsap-trial";

// or get other plugins:
import ScrollTrigger from "gsap-trial/ScrollTrigger";
import DrawSVGPlugin from "gsap-trial/DrawSVGPlugin";

// or all tools are exported from the "all" file (excluding bonus plugins):
import { gsap, ScrollTrigger, DrawSVGPlugin } from "gsap-trial/all";

// don't forget to register plugins
gsap.registerPlugin(ScrollTrigger, DrawSVGPlugin); 

The NPM files are ES modules, but there is also a /dist/ directory with UMD files for extra compatibility. Some build tools don't understand ES Modules in which case you can import the UMD files by adding /dist/ like:

// UMD imports
import gsap from "gsap-trial/dist/gsap";
import MorphSVGPlugin from "gsap-trial/dist/MorphSVGPlugin";

Use an alias to make upgrading simple

Install the package as a "gsap" alias so that when you join Club GSAP and get the unrestricted files, all you have to do is install those and make zero changes to all your imports!

npm install gsap@npm:gsap-trial

Now we can simply use "gsap" in place of "gsap-trial", so the imports could look like this:

import gsap from "gsap";
import DrawSVGPlugin from "gsap/DrawSVGPlugin";

How do I get unrestricted files?

Once you're a Club GSAP member, download the unrestricted plugins from your gsap.com account and then include them in your own JS payload. There are no "phone home" scripts that track usage and the plugins won't suddenly stop working if/when your membership expires. We treat others the way we'd like to be treated and our entire business model is built on the honor system. Read about it here. GSAP has a private NPM registry for members too.

Post your questions in our forums and we'd be happy to help.

Using React?

There's a @gsap/react package that exposes a useGSAP() hook which is a drop-in replacement for useEffect()/useLayoutEffect(), automating cleanup tasks. Please read the React guide for details.

Get Started

ScrollTrigger and ScrollSmoother

If you're looking for scroll-driven animations, GSAP's ScrollTrigger plugin is the new standard. There's a companion ScrollSmoother as well.

Resources

• gsap.com
• Getting started guide
• Docs
• Demos & starter templates
• Community forums
• Ease Visualizer
• Showcase
• YouTube Channel
• Cheat sheet
• Club GSAP (get access to unrestricted bonus plugins)

What is Club GSAP?

There are 3 main reasons anyone signs up for Club GSAP:

• To get access to snazzy members-only plugins like MorphSVG, SplitText, ScrollSmoother, etc.
• To get the special commercial license.
• To support ongoing development efforts and cheer us on.

Learn more.

Need help?

The GSAP forums are an excellent place to learn and get your questions answered. Report any bugs there too please (it's also okay to file an issue on Github if you prefer).

License

Please do not use any of the bonus plugins without the proper license which comes with Club GSAP memberships. GSAP's standard "no charge" license for the public files can be viewed at https://gsap.com/standard-license. Club GSAP members are granted additional rights. See http://gsap.com/licensing/ for details. Why doesn't GSAP use an MIT (or similar) open source license, and why is that a good thing? This article explains it all: http://gsap.com/why-license/

Copyright (c) 2008-2023, GreenSock. All rights reserved.