Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/epranka/scrollmagic-plugin-gsap
Add animation.gsap.js plugin to ScrollMagic in ES6 with no problems
https://github.com/epranka/scrollmagic-plugin-gsap
animation gsap plugin scrollmagic tweenlite tweenmax
Last synced: about 1 month ago
JSON representation
Add animation.gsap.js plugin to ScrollMagic in ES6 with no problems
- Host: GitHub
- URL: https://github.com/epranka/scrollmagic-plugin-gsap
- Owner: epranka
- License: mit
- Created: 2019-02-13T19:14:00.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-12-20T19:29:53.000Z (about 5 years ago)
- Last Synced: 2024-11-14T09:17:09.936Z (about 2 months ago)
- Topics: animation, gsap, plugin, scrollmagic, tweenlite, tweenmax
- Language: JavaScript
- Size: 15.6 KB
- Stars: 29
- Watchers: 1
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# scrollmagic-plugin-gsap
Original animation.gsap.js plugin for ScrollMagic is not compatible with ES6 modules, so it's causing a number of problems to add it in ES6 environment. Use this module to simple wrap ScrollMagic with animation.gsap.js in ES6. Has Typescript definition in module.
```
npm install --save scrollmagic-plugin-gsap
```
or
```
yarn install scrollmagic-plugin-gsap
```
### Usage
```js
import * as ScrollMagic from "scrollmagic"; // Or use scrollmagic-with-ssr to avoid server rendering problems
import { TweenMax, TimelineMax } from "gsap"; // Also works with TweenLite and TimelineLite
import { ScrollMagicPluginGsap } from "scrollmagic-plugin-gsap";
ScrollMagicPluginGsap(ScrollMagic, TweenMax, TimelineMax);
// There you can use setTween() in ScrollMagic Scene with no problems
```
### Author
Edvinas pranka
[@epranka](https://twitter.com/epranka)
https://www.kodmina.lt
# License
The MIT License (MIT)
Copyright (c) 2019 Edvinas Pranka
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.