Scroll Effect

A simple library, where you can flow in the elements as soon, as the user is scrolling to them.

Requirements

Before you can start using the library, make sure that you are using the Animate.css library, which provides custom animations. That's the only thing you need.

How it works

All you need to do is to install the library on your project with

npm install scroll-effect

Then you can simply add to your elements, which you want to flow in later a class called "scroll-effect" and add the inline-style opacity:0; or you can add an entry in your CSS where you define the .scroll-effect class as opacity:0;. In the end, it looks something like this:

<div class='scroll-effect' style='opacity:0;'>
</div>

As this library uses the Animate.css library to flow in the elements with animations, you can use every animation listed there.

By default, if nothing is defined like the example above, it will use the fadeIn animation. If you want to trigger a custom animation, just simply add the attribute data-animation and set the value to the animation name.

<div class='scroll-effect' style='opacity:0;' data-animation="bounceInLeft">
</div>

Data options

You can provide additional information about your element to improve the experience. Just pass the following data attributes to the element, which uses the scroll-effect class.

| data-* | Default | Description | Example | |--------|---------|-------------|---------| | animation | fadeIn | The animation name of animate.css, which should be displayed. | fadeInUp, etc. | | delay | 0 | Add a delay of the animation, controlled via animate.css in seconds | 2 | | offsetFactor | 1.5 | Adds an offset factor, when the animation should be triggered. 2 is in the middle of the screen. 1.5 is in the lower half (triggers earlier), while 3 is in the upper half (triggers later) of the screen. | 3 |

How to use it in Vue.js

If you want to use this library in Vue.js you only have to insert the following snippet in the App.vue JavaScript section:

const ScrollEffect = require("scroll-effect");

document.addEventListener("DOMContentLoaded", function() {
  ScrollEffect.init(); //Initialize the scroll effect, when all the DOM elements has been loaded and placed.
});