Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bitworking/react-gsap

React components for GSAP
https://github.com/bitworking/react-gsap

Last synced: 13 days ago
JSON representation

React components for GSAP

Host: GitHub
URL: https://github.com/bitworking/react-gsap
Owner: bitworking
License: other
Created: 2018-10-04T00:24:52.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2023-05-23T20:11:38.000Z (over 1 year ago)
Last Synced: 2024-03-14T20:32:59.983Z (8 months ago)
Language: TypeScript
Homepage: https://bitworking.github.io/react-gsap/
Size: 15.2 MB
Stars: 542
Watchers: 8
Forks: 32
Open Issues: 36
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# react-gsap

> React components for GSAP

[![NPM](https://img.shields.io/npm/v/react-gsap.svg)](https://www.npmjs.com/package/react-gsap)
![npm type definitions](https://img.shields.io/npm/types/react-gsap)
![npm bundle size (version)](https://img.shields.io/bundlephobia/minzip/react-gsap/^2)

# Introduction

`react-gsap` lets you use the GreenSock Animation Platform (GSAP) in React in a fully declarative way.
It abstracts away the direct use of the GSAP [Tween](https://greensock.com/docs/v3/GSAP/Tween) and [Timeline](https://greensock.com/docs/v3/GSAP/Timeline) functions.

If you need the full control it's possible by getting low level access to the underlying objects.

In addition to that it ships some GSAP Plugins and useful helper components.

From version 2 on it's build for GSAP 3 and only has `gsap` as a peer dependency. In this way you can update `gsap` separately from `react-gsap`.

It's built with TypeScript and ships the types directly in the package.

Documentation and examples are here: https://bitworking.github.io/react-gsap/

##### The examples on the documentation pages are all editable directly in the browser. So play with it!

## Installation

```bash
npm install gsap react-gsap
```

## About GSAP

GreenSock Animation Platform (GSAP) is a set of some JavaScript functions which let you tween a value/attribute/css property over time and insert these tweens into a timeline for more complex animations.

`react-gsap` just adds some React wrapper components for these functions, so also read the official GreenSock documentation to know how to do things:

[GreenSock Docs](https://greensock.com/docs/)

## License