@kolonstudio/gos
v1.1.0
Published
Gsap on scroll
Downloads
14
Readme
GOS
Gos "Greensock on scroll" is a library inspired by AOS.
GOS allows you to animate elements as you scroll down, and up. If you scroll back to top, elements will animate to it's previous state and are ready to animate again if you scroll down.
Rather than using CSS animations as AOS does, GOS utilizes Greensock Tweens.
⚙ Installation
Using package managers
Install gos
package:
yarn add @kolonstudio/gos
- or
npm install --save @kolonstudio/gos
Import script, initialize GOS:
import GOS from '@kolonstudio/gos'
// You can also pass an option settings object
// below listed deafult settings
GOS.init({
duration: 1000, // duration in milliseconds
ease: 'power1.inOut', // easeing string See https://greensock.com/ease-visualizer for all availiable easings
delay: 0, // Delat the animation by x milliseconds
startEvent: 'DOMContentLoaded', // name of the event dispatched on the document, that GOS should initialize on
offset: 120, // offset (in px) from teh original trigger point
disable: false, // accepts true or false
mirror: false, // whether elements should animate out while scrolling past them
once: false, // whether animation should happen only once - while scrolling down
anchorPlacement: 'top-bottom', // defines which position of the element regarding to window should trigger the animation
disableMutationObserver: false, // disables automatic mutations' detections (advanced)
throttleDelay: 99, // the delay on throttle used while scrolling the page (advanced)
debounceDelay: 50, // the delay on debounce used while resizing window (advanced)
animations: {}, // Read more about the animations below
})
🤔 How to use it?
The element you wish to animate can have the following attributes data-gos-*
attributes:
<div
data-gos="fadeIn"
data-gos-delay="50"
data-gos-offset="200"
data-gos-duration="1000"
data-gos-ease="power1.inOut"
data-gos-mirror="true"
data-gos-once="false"
data-gos-anchor-placement="top-center"
></div>
💣 The animations
Here is an example of the standard "fadeIn" animation
import gsap from 'gsap'
const fadeIn = {
defaultStyles: {
opacity: 0,
},
animateIn(el: gsap.TweenTarget, defaultOptions: gsap.TweenVars) {
return gsap.to(el, {
...defaultOptions,
opacity: 1,
})
},
// The animationOut method is optional
animateOut(el: gsap.TweenTarget, defaultOptions: gsap.TweenVars) {
return gsap.to(el, {
...defaultOptions,
opacity: 0,
})
},
}
export default fadeIn
🤔 How to import the animation ?
When you initialize the GOS.init() you can pass an animations object as an option like so
import GOS from '@kolonstudio/gos'
import fadeUp from './animations/fadeUp'
// You can also pass an option settings object
// below listed deafult settings
GOS.init({
animations: { fadeUp },
})
Each key (name) in the animations object can be used in the data-gos
attribute on
<div data-gos="fadeUp"></div>
❔Questions
If you found a bug, have a question or an idea, please contact kolon.studio.