ScrollReveal

Animate elements as they scroll into view.

Scrolling
jlmakes/scrollrevealscrollrevealjs.org/scrollreveal

README

ScrollReveal

ScrollReveal

Animate elements as they scroll into view.

Build status Monthly downloads Version 5.7 kB min+gzip GPLv3 License


Introduction


ScrollReveal is a JavaScript library for easily animating elements as they enter/leave the viewport. It was designed to be robust and flexible, but hopefully you’ll be surprised below at how easy it is to pick up.

Installation


Browser


A simple and fast way to get started is to include this script on your page:

  1. ``` html
  2. <script src="https://unpkg.com/scrollreveal"></script>
  3. ```

This will create the global variable ScrollReveal

Be careful using this method in production. Without specifying a fixed version number, Unpkg may delay your page load while it resolves the latest version. Learn more at unpkg.com


Module


  1. ``` sh
  2. npm install scrollreveal
  3. ```

CommonJS


  1. ``` js
  2. const ScrollReveal = require('scrollreveal')
  3. ```

ES2015


  1. ``` js
  2. import ScrollReveal from 'scrollreveal'
  3. ```

Usage


Installation provides us with the constructor function [ScrollReveal()](https://scrollrevealjs.org/api/constructor.html). Calling this function returns the ScrollReveal instance, the “brain” behind the magic.

ScrollReveal employs the singleton pattern; no matter how many times the constructor is called, it will always return the same instance. This means we can call it anywhere, worry-free.


There’s a lot we can do with this instance, but most of the time we’ll be using the [reveal()](https://scrollrevealjs.org/api/reveal.html) method to create animation. Fundamentally, this is how to use ScrollReveal:

  1. ``` html
  2. <h1 class="headline">
  3. Widget Inc.
  4. </h1>
  5. ```

  1. ``` js
  2. ScrollReveal().reveal('.headline')
  3. ```

🔎 See this demo live on JSBin


The full documentation can be found at https://scrollrevealjs.org


If you’re using an older version of ScrollReveal, you can find legacy documentation in the wiki



Commercial License Badge

License


For commercial sites, themes, projects, and applications, keep your source code private/proprietary by purchasing a Commercial License.

Licensed under the GNU General Public License 3.0 for compatible open source projects and non-commercial use.

Copyright 2021 Fisssion LLC