scrollscene

ScrollScene

ScrollScene is an extra layer on top of ScrollMagic as well as using IntersectionObserver to achieve similar effects.

Examples

View the online Storybook.

Install

yarn add scrollscene scrollmagic

or

npm install scrollscene scrollmagic

Import

ScrollScene (uses ScrollMagic)

import { ScrollScene } from 'scrollscene'

ScrollObserver (uses IntersectionObserver)

import { ScrollObserver } from 'scrollscene'

ScrollMagic (with SSR catch)

import { ScrollMagic } from 'scrollscene'

or

import { ScrollMagicSsr } from 'scrollscene'

ScrollMagic and ScrollMagicSsr are the exact same thing.

Options

ScrollScene has breakpoints, duration, gsap, offset, scrollMagic, toggle, triggerElement, triggerHook.

ScrollObserver has breakpoints, gsap, observer, offset, thresholds, toggle, triggerElement, useDuration, video.

triggerElement: document.querySelector('#element') is used to set the element you wish to trigger events based upon.

gsap has gsap: { timeline: myTimeline, reverseSpeed: 2, yoyo: true, delay: 2 }.

toggle has toggle: { element: containerRef.current, className: 'lets-do-this' }.

offset under ScrollScene is used to change the ScrollMagic offset.

triggerHook used to change the ScrollMagic triggerHook.

scrollMagic has scrollMagic: { loglevel: 1 }. Add anything from new ScrollMagic.Scene(options).

breakpoints: { 0: false, 768: true } is used to set responsiveness of the new ScrollMagic.Scene, mobile-first.

duration is duration: '100%' OR duration: { 0: '50%', 768: '100% } is used to set responsiveness of the new ScrollMagic.Scene, mobile-first.

offset under ScrollObserver is used to change the rootMargin easy. offset: '-10% will be rootMargin: '-10% 0%'.

observer: { rootMargin: '-50% 0%' } is used to pass extra options to pass the IntersectionObserver, like root, rootMargin, or threshold (to override the thresholds option). observer: { rootMargin: '0px', threshold: 1.0 }

thresholds: 1 is to set the number of thresholds you want. thresholds: 100 = [0, 0.1, 0.2, ... 0.98, 0.99, 1]

useDuration: true to use the percentage of element visibility to scrub the gsap timeline. Similar to ScrollMagic Duration on a Gsap timeline, but not quite the same if the element is longer than the viewport height, thus the element visibility will never reach 100%, thus the gsap timeline will never reach 100%.

See below for examples.

Key Notes

• This project sought out to overcome the issues of using Gsap3 with ScrollMagic, as well as ESM related problems. In the end it added more features, like video playback, scene init breakpoints, scene duration breakpoints, gsap speed controls, and using an IntersectionObserver when it fits your usecase better.
• Is written in TypeScript so you have access to the types.
• This does not include gsap or scrollmagic. If you plan to use them, you'll need to install them in addition to scrollscene.
• This works with Gsap without having to import the extra animation.gsap.js file from ScrollMagic (though you'll have to install in yourself yarn add gsap or npm install gsap). In turn this is smaller than using ScrollMagic and animation.gsap.js.
• It allows for scene init breakpoints, and for scene duration breakpoints. This will also will on SSR if implemented correctly.
• You do not need to create a ScrollMagic controller. It is done for you.
• This will Tree Shake if your webpack is set up correctly. Next.js, for example, does this for you. Thus you can just ScrollObserver and not ScrollScene if you wanted and your build should exclude ScrollScene and scrollmagic (as long as you did import them).
• Does not work with jQuery. You need to provide a domNodeSelector. Whether a document.querySelector('#element') or React ref myRef.current.
• I'll add a setPin in the future. Though you can do this now with import { ScrollMagic } from 'scrollscene' and do a setPin this way. Just remember you also have to create a controller using this method and attach the scene to it.

Usage

ScrollScene (uses ScrollMagic)

const myElement = document.querySelector('#element')

const scrollScene = new ScrollScene({
  triggerElement: myElement,
})

Toggle a className

const scrollScene = new ScrollScene({
  triggerElement: domNode,
  toggle: {
    element: anotherDomNode,
    className: 'turn-blue',
  },
})

Toggle a className on a duration

const scrollScene = new ScrollScene({
  triggerElement: domNode,
  toggle: {
    element: anotherDomNode,
    className: 'turn-blue',
    reverse: true,
  },
  triggerHook: 1,
  duration: '100%',
})

Add extra options from ScrollMagic (like a triggerHook or offset)

const scrollScene = new ScrollScene({
  triggerElement: domNode,
  toggle: {
    element: anotherDomNode,
    className: 'turn-blue',
  },
  offset: 50,
  triggerHook: 0.5,
})

or anything from new ScrollMagic.Scene(options) under the scrollMagic key to contain those options.

const scrollScene = new ScrollScene({
  triggerElement: domNode,
  toggle: {
    element: anotherDomNode,
    className: 'turn-blue',
  },
  scrollMagic: {
    logLevel: 1,
  },
})

Using GSAP (Greensock)

// create a timeline and add a tween
const myTimeline = gsap.timeline({ paused: true })

myTimeline.to(domNode, {
  x: -200,
  duration: 1,
  ease: 'power2.out',
})

const scrollScene = new ScrollScene({
  triggerElement: domNode,
  gsap: {
    timeline: myTimeline,
  },
})

Using GSAP (Greensock), and setting the reserveSpeed

// create a timeline and add a tween
const myTimeline = gsap.timeline({ paused: true })

myTimeline.to(domNode, {
  x: -200,
  duration: 1,
  ease: 'power2.out',
})

const scrollScene = new ScrollScene({
  triggerElement,
  gsap: {
    timeline: tl,
    reverseSpeed: 4,
  },
})

Using GSAP (Greensock), and tying it to the user scrolling with a duration

// create a timeline and add a tween
const myTimeline = gsap.timeline({ paused: true })

myTimeline.to(domNode, {
  x: -200,
  duration: 1,
  ease: 'power2.out',
})

const scrollScene = new ScrollScene({
  triggerElement,
  gsap: {
    timeline: tl,
  },
  duration: 500,
})

ScrollObserver (uses IntersectionObserver)

Toggle a className while element is visible on the page

const scrollObserver = new ScrollObserver({
  triggerElement: domNode,
  toggle: {
    element: anotherDomNode,
    className: 'turn-blue',
  },
})

Toggle a Gsap animation while element is visible on the page

// create a timeline and add a tween
const tl = gsap.timeline({ paused: true })

tl.to(squareElement, {
  x: -200,
  duration: 1,
  ease: 'power2.out',
})

const scrollObserver = new ScrollObserver({
  triggerElement: domNode,
  gsap: {
    timeline: tl,
  },
})

Toggle a Gsap animation while element is visible on the page with a yoyo effect and repeat delay of 0

// create a timeline and add a tween
const tl = gsap.timeline({ paused: true })

tl.to(squareElement, {
  x: -200,
  duration: 1,
  ease: 'power2.out',
})

const scrollObserver = new ScrollObserver({
  triggerElement: domNode,
  gsap: {
    timeline: tl,
    yoyo: true,
    delay: 0,
  },
})

Scrub a Gsap timeline based on element visibility

// create a timeline and add a tween
const tl = gsap.timeline({ paused: true })

tl.to(squareElement, {
  x: -200,
  duration: 1,
  ease: 'power2.out',
})

const scrollObserver = new ScrollObserver({
  triggerElement: domNode,
  gsap: {
    timeline: tl,
  },
  useDuration: true,
})

Start a video when an element is visible and pause the video when it's not

const scrollObserver = new ScrollObserver({
  triggerElement: domNode,
  video: {
    element: videoTagDomNode,
  },
})

Set a different threshold

The below would create an array of 100 thresholds ([0, 0.1, 0.2, ... 0.98, 0.99, 1]), effectively says any percent from 1 to 100 of the element intersecting the viewport should trigger the scene.

const scrollObserver = new ScrollObserver({
  triggerElement: domNode,
  thresholds: 100,
})

Extra observer options

The below adds extra options to the IntersectionObserver. See others properities you could add here.

const scrollObserver = new ScrollObserver({
  triggerElement: domNode,
  observer: { rootMargin: '-50% 0%' },
})

or

const scrollObserver = new ScrollObserver({
  triggerElement: domNode,
  observer: {
    rootMargin: '0px',
    threshold: 1.0,
  },
})

Destroy the scene

Whatever you've named your scene, whether const scrollScene or const scrollObserver, you can destroy it with...

scrollScene.destroy()

scrollObserver.destroy()

Using React?

With React it's best to do this inside either a useEffect hook or using the componentDidMount and componentWillUnmount lifecycle. Whatever you choose, make sure to destroy the scene on the unmount.

See the Storybook source for good examples (story.js) found here.

import { ScrollScene } from 'scrollscene'

const MyComponent = () => {
  // init ref
  const containerRef = React.useRef(null)
  const triggerRef = React.useRef(null)

  React.useEffect(() => {
    const { current: containerElement } = containerRef
    const { current: triggerElement } = triggerRef

    if (!containerElement && !triggerElement) {
      return undefined
    }

    const scrollScene = new ScrollScene({
      triggerElement: triggerElement,
      toggle: {
        element: containerElement,
        className: 'turn-blue',
      },
    })

    // destroy on unmount
    return () => {
      scrollScene.destroy()
    }
  })

  return (
    <div ref={containerRef}>
      <div style={{ height: '50vh' }} />

      <h3>Basic Example</h3>
      <h1>Scroll Down</h1>

      <div style={{ height: '150vh' }} />

      <div ref={triggerRef}>When this hits the top the page will turn blue</div>

      <div style={{ height: '150vh' }} />
    </div>
  )
}

Other options

You can now set breakpoints so you scene is more responsive. They work mobile first. The below would set up a scene on tablet, but not mobile, and resizing will init and destroy.

const scrollScene = new ScrollScene({
  breakpoints: { 0: false, 768: true },
})

duration also can be responsive, finally! The below would set up a scene that lasts 50vh on mobile, 100% after.

const scrollScene = new ScrollScene({
  duration: { 0: '50%', 768: '100%' },
})

Polyfill

In order to use ScrollObserver on IE, you'll need a polyfill IntersectionObserver. You can do this with loading a polyfill script from https://polyfill.io/.

Using Next.js or Webpack?

With Next.js you can load polyfills another way. See https://github.com/zeit/next.js/blob/canary/examples/with-polyfills/client/polyfills.js.

Add following to client/polyfills.js

/*
 * This files runs at the very beginning (even before React and Next.js core)
 * https://github.com/zeit/next.js/blob/canary/examples/with-polyfills/client/polyfills.js
 */

// https://www.npmjs.com/package/intersection-observer
import 'intersection-observer'

And then modify the next.config.js

// next.config.js

const nextConfig = {
  webpack(config) {
    /*
     * Add polyfills
     * https://github.com/zeit/next.js/blob/canary/examples/with-polyfills/next.config.js
     */

    const originalEntry = config.entry
    config.entry = async () => {
      const entries = await originalEntry()

      if (entries['main.js'] && !entries['main.js'].includes('./client/polyfills.js')) {
        entries['main.js'].unshift('./client/polyfills.js')
      }

      return entries
    }

    return config
  },
}

module.exports = nextConfig

For more on ScrollMagic, hit up scrollmagic.io/ and https://github.com/janpaepke/ScrollMagic