ScrollyJS

ScrollyJS is a lightweight, zero-dependency JavaScript library for triggering CSS animations when elements enter the viewport — on scroll, hover, click, or custom triggers.

Zero config for default scroll-based animation
Custom triggers like mouseenter, click, and more
Built with IntersectionObserver
Lightweight and fast
Easily extendable

You can create a rich and storytelling animated web pages with up and down scrolling 👋 Visitors can feel the page with scrolling and it has a really minimal learning curve.

Installation

Using npm

npm install scrollyjs

import Scrolly from "scrollyjs";
Scrolly.init();

Using CDN

<script src="https://unpkg.com/scrollyjs/dist/scrolly.min.js"></script>
<script>
  Scrolly.init();
</script>

Animation Classes

ScrollyJS uses pre-built animation classes from {css}animation. You can either include them via CDN or install them as part of your project.

➕ Add cssanimation Option 1: Use CDN (Recommended for quick use)

<link
  href="https://cdn.jsdelivr.net/npm/@hellouxpavel/cssanimation@latest/dist/cssanimation.min.css"
  rel="stylesheet" />

Option 2: Install via npm

npm i @hellouxpavel/cssanimation

Then import it:

import "@hellouxpavel/cssanimation";

Getting Started

Define DOWN Animation

Once you've done that, define animation class name in data-scrolly-down attribute like the example below to the element that you want to animate when the page scroll to DOWN. here we are using blurInTop.

<div data-scrolly-down="blurInTop">it's easy to do</div>

Define TOP Animation

Like the DOWN animation, to animate element while scrollig to TOP, just use data-scrolly-top attribute and add whatever animation you want. We used blurInBottom for example.

<div data-scrolly-top="blurInBottom">it's easy to do</div>

Use Both DOWN and TOP Animation

You can also trigger an animation effect in any given element from both DOWN & TOP, means it will animate on both scrolling DOWN & TOP. See the example below-

<div data-scrolly-top="blurInBottom" data-scrolly-down="blurInTop">
  it's easy to do
</div>

Use Animation on Character

Yes!! you can now animate each character of any sentences while you scroll. Add data-scrolly-characters="sequential" for sequential animation of the characters or data-scrolly-characters="random" if you want it to animate it in random order.... isn't it exciting !!

<h1
  data-scrolly-characters="sequentially"
  data-scrolly-down="leSpinInRight"
  data-scrolly-top="leSpinInLeft">
  I am Awesome. I can animate every characters in a sentence
</h1>

<h1
  data-scrolly-characters="randomly"
  data-scrolly-down="leSpinInRight"
  data-scrolly-top="leSpinInLeft">
  I am Awesome. I can animate every characters in a sentence
</h1>

Add Delay in Character Animation

You can add dealy on character animation by adding data-scrolly-characters="delay:100" attribute.

<h1
  data-scrolly-characters="sequentially"
  data-scrolly-characters="delay:100"
  data-scrolly-down="leSpinInRight"
  data-scrolly-top="leSpinInLeft">
  I am Awesome. I can animate every characters in a sentence
</h1>

<h1
  data-scrolly-characters="randomly"
  data-scrolly-characters="delay:100"
  data-scrolly-down="leSpinInRight"
  data-scrolly-top="leSpinInLeft">
  I am Awesome. I can animate every characters in a sentence
</h1>

Use Animation Duration

Default animation duration is 1s but you can always define your custom duration by adding duration:[number]s attribute.

<div data-scrolly-down="blurInTop, duration:2s">it's easy to do</div>

Add Delay

By adding the attribute delay:[number]s you can set a delay time to start of an animation.

<div data-scrolly-down="blurInTop, delay:2s">I am start after 2s</div>

Infinite or Specify The Number of Animation

The iteration-count specifies the number of times an animation should be played. Use iteration-count: 3 if you want to animate 3 times or use iteration-count:infinite which should play the animation with no limit.

<div data-scrolly-down="blurInTop, iteration-count:3">I am animate 3 times</div>

<div data-scrolly-down="blurInTop, iteration-count:infinite">
  I am animate unlimited times
</div>

Animation Direction

You can run the animation in reverse direction or alternate cycle (forward, backward, then again forward) using direction attribute.

<div data-scrolly-down="blurInTop, direction:reverse">it's easy to do</div>

<div data-scrolly-top="moveFromRight, iteration-count:3, direction:alternate">
  it's easy to do
</div>

Timing Function

You can add all CSS pre-defined speed curve ease, ease-in, ease-out, linear of an animation or define your own values with a cubic-bezier function by adding timing-function attribute.

<div data-scrolly-down="blurInTop, timing-function:linear">it's easy to do</div>

<div
  data-scrolly-down="blurInTop, timing-function:cubic-bezier(.17,.67,.83,.67)">
  it's easy to do
</div>

Define Top Offset Value

Set the top animation starting point after it appears on the browser window data-scrolly-offset-top="300px".

<div data-scrolly-down="blurInTop" data-scrolly-offset-top="300px">
  it's easy to do
</div>

Define Bottom Offset Value

Like the top offset the data-scrolly-offset-bottom="500px" attribute can be used to set the bottom starting point of the animation.

<div data-scrolly-down="blurInBottom" data-scrolly-offset-bottom="500px">
  it's easy to do
</div>

On Click Animtion

Initiate the animation with on click event using by data-scrolly-click="fadeIn".

<div data-scrolly-down="blurInBottom" data-scrolly-click="fadeIn">
  I am animate when you click me. Please click
</div>

Mouse Over Animtion

For mouse over animation add the data-scrolly-mouseover="zoomIn" attribute

<div data-scrolly-down="blurInBottom" data-scrolly-mouseover="zoomIn">
  I am animate when you hover me
</div>

Mouse Out Animtion

Add data-scrolly-mouseout="fadeInLeft" attribute to animate on mouse out event.

<div data-scrolly-down="blurInBottom" data-scrolly-mouseout="fadeInLeft">
  I am animate when you click me
</div>

Targeted Object Animate When You Click

Targeted Object Animate When You Click: If you want to animate a content by clicking by another one, follow this simple instruction.

<input
  type="button"
  value="Hit me to Animate targetd object"
  data-srolly-selector="targetElement" />

<div
  data-scrolly-selector="targetElement"
  data-scrolly-target-click="pushReleaseFromBottom">
  I am animate your target object when you click me
</div>

Targeted Object Animate When You Mouse Over

Animate any content while hovering mouse on another one.

<input
  type="button"
  value="Hit me to Animate targetd object"
  data-srolly-selector="targetElement" />

<div
  data-scrolly-selector="targetElement"
  data-scrolly-target-click="flipYZoomIn">
  I am animate your target object when you hover me
</div>

Targeted Object Animate When You Mouse Out

Unlike those two follow the instruction below to animate targeted contents while doing mouse out on another one.

<input
  type="button"
  value="Hit me to Animate targetd object"
  data-srolly-selector="targetElement" />

<div
  data-scrolly-selector="targetElement"
  data-scrolly-target-click="rotateInLeft">
  I am animate your target object when you mouse out from me
</div>

Advanced Settings

Scrolly Offset Top – specifies the distance between the beginning of the object and the beginning of the browser window from top

Default value – 0px
Example value – 20px
Uses –

scrolly({
  scrollyOffsetTop: 20,
});

Scrolly Offset Bottom – specifies the distance between the beginning of the object and the ending of the browser window from bottom

Default value – 0px
Example value – 20px
Uses –

scrolly({
  scrollyOffsetBottom: 20,
});

Scrolly [OS name] Offset Top – specifies the distance between the beginning of the object and the beginning of the browser window from top based on OS and devices

OS Supports – MAC OS and Windows
Default value – 0px
Example value – 200px
Uses –

scrolly({
  scrollyMacOffsetTop: 200 /*Setting Offset Top Value for MAC*/,
  scrollyWindowsOffsetTop: 200 /*Setting Offset Top Value for Windows*/,
});

Scrolly [OS Name] Offset Bottom – specifies the distance between the beginning of the object and the ending of the browser bottom window based on OS and devices

OS Supports – MAC OS and Windows
Default value – 0px
Example value – 200px
Uses –

scrolly({
  scrollyMacOffsetBottom: 200 /*Setting Offset Bottom Value for MAC*/,
  scrollyWindowsOffsetBottom: 200 /*Setting Offset Bottom Value for Windows*/,
});

Scrolly [Device] Offset Top – specifies the distance between the beginning of the object and the beginning of the browser window from top based on OS and devices

Device Supports – Tab and Mobile
Default value – 0px
Example value – 200px
Uses –

scrolly({
  scrollyTabOffsetTop: 200 /*Setting Offset Top Value for Tab*/,
  scrollyMobileOffsetTop: 200 /*Setting Offset Top Value for Mobile*/,
});

Scrolly [Device Name] Offset Bottom – specifies the distance between the beginning of the object and the ending of the browser bottom window based on OS and devices

Device Supports – Tab and Mobile
Default value – 0px
Example value – 200px
Uses –

scrolly({
  scrollyTabOffsetBottom: 200 /*Setting Offset Bottom Value for Tab*/,
  scrollyMobileOffsetBottom: 200 /*Setting Offset Bottom Value for Mobile*/,
});

Scrolly Stop It – There are several options that you can use to destroy scrolly on certains devices.

Default value – false
Type – Boolean
Device Supports – Large Desktop, Desktop, Tab and Mobile
Example value – mobile: true
Uses –

scrolly({
  scrollyStopIt: {
    largeDesktop: false,
    desktop: false,
    mobile: true,
    tab: false,
  },
});

Scrolly Disable – you can use scrollyDisable to kill scrolly.

Default value – false
Type – Boolean
Example value – true
Uses –

scrolly({
  scrollyDisable: true,
});

Why Scrolly.js

Scrolly JS is efficient and flexible JavaScript library for building an interactive and attractive animation with scrolling. Fully responsive, lightweight, powerful and flexible pure JavaScript scroll animation library.

Animated by CSS

Your imagination can be real. Just imagine and implement your own animation effect with this platform.

Flexibility and extendibility

Easy-going installation and flexible scroll animation library that have insignificant production time. The platform is developer friendly and extendable.

Support for responsive

This is 100% responsive and ready for all devices with any screen resolutions.

Lightweight

Just a 12KB file which is really lightweight to use any of your projects.

Easy to use

A Very easiest scroll animation library which has extensive features to build any scroll animation as you want.

No dependency

Plug and play and ready to implement. No dependency with any third party JavaScript plugin, framework or library.

Pricing Guide

ScrollyJS is completely free to use. For any commercial projects, themes or any applications you should have to buy a commercial license. We offer you to a commercial license with two different packages. To learn more please take a look our support and licensing sections.

Name		Name	Last commit message	Last commit date
Latest commit History 32 Commits
.github/workflows		.github/workflows
dist		dist
docs		docs
src		src
.gitignore		.gitignore
.npmignore		.npmignore
CHANGELOG.md		CHANGELOG.md
README.md		README.md
package-lock.json		package-lock.json
package.json		package.json
vite.config.js		vite.config.js

yesiamrocks/scrollyJS

Folders and files

Latest commit

History

Repository files navigation

ScrollyJS

Installation

Using npm

Using CDN

Animation Classes

Getting Started

Define DOWN Animation

Define TOP Animation

Use Both DOWN and TOP Animation

Use Animation on Character

Add Delay in Character Animation

Use Animation Duration

Add Delay

Infinite or Specify The Number of Animation

Animation Direction

Timing Function

Define Top Offset Value

Define Bottom Offset Value

On Click Animtion

Mouse Over Animtion

Mouse Out Animtion

Targeted Object Animate When You Click

Targeted Object Animate When You Mouse Over

Targeted Object Animate When You Mouse Out

Advanced Settings

Why Scrolly.js

Animated by CSS

Flexibility and extendibility

Support for responsive

Lightweight

Easy to use

No dependency

Pricing Guide

About

Topics

Resources

Uh oh!

Stars

Watchers

Forks

Releases 2

Packages 0

Uh oh!

Contributors 2

Uh oh!

Languages

Packages