Popularity
2.8
Growing
Activity
6.7
Declining
854
17
83

Monthly Downloads: 0
Programming language: JavaScript
Tags: Scroll    
Latest version: v5.3.0

simpleParallax alternatives and similar libraries

Based on the "Scroll" category

Do you think we are missing an alternative of simpleParallax or a related project?

Add another 'Scroll' Library

README

simpleParallax logo

GitHub version Only 32 Kb GitHub issues code style: prettier

simpleParallax.js

simpleParallax.js is a very simple and tiny Vanilla JS library that adds parallax animations on any images.

Where it may be laborious to get results through other plugins, simpleParallax.js stands out for its ease and its visual rendering. The parallax effect is directly applied to image tags, there is no need to use background images. More info on the case study here.

Any image will fit. Try it out!

Installation

Old way

Simply copy/paste the below snippet just before your closing </body> tag:

<script src="simpleParallax.js"></script>

or use the below CDN link provided by jsDelivr.com:

<script src="https://cdn.jsdelivr.net/npm/simple-parallax-js@5.3.0/dist/simpleParallax.min.js"></script>

Via npm/yarn

You can also install it via:

#npm
npm install simple-parallax-js

#yarn
yarn add simple-parallax-js

and then import it as follows:

//ES6 import
import simpleParallax from 'simple-parallax-js';

//CommonJS
const simpleParallax = require('simple-parallax-js');

Initialization

Giving the following HTML:

 <img class="thumbnail" src="image.jpg" alt="image">

simply add the following JavaScript code:

const image = document.getElementsByClassName('thumbnail');
new simpleParallax(image);

and voilĂ !


You can also choose to apply the parallax on multiple images:

const images = document.querySelectorAll('img');
new simpleParallax(images);

Settings

Setting Type Default Hint
orientation String up up - right - down - left - up left - up right - down left - down right
scale Number 1.3 need to be above 1
overflow Boolean false
delay Number 0.4 the delay is in second
transition String false any CSS transition
customContainer String or Node false
maxTransition Number 0 it should be a percentage between 1 and 99

You can apply these settings with the following JS code:

var images = document.querySelectorAll('.thumbnail');
new simpleParallax(images, {
    delay: 0,
    orientation: 'down',
    scale: 1.3,
    overflow: true,
    customContainer: '.container'
});

orientation - String - see example

This is the orientation (or direction) of the parallax effect. Choose up and when scrolling down, the image will translate from the bottom to the top (so the image will translate up). When scrolling up, the image will translate from the top to the bottom. Same logic apply for all others orientations (right, down, left, up left, up right, down left or down right). When 2 directions are combined (for example down right), the image will translate diagonally.

scale - Number - see example

The higher the scale is set, the more visible the parallax effect will be. In return, the image will lose in quality. To reduce the lossless effect, if the scale is set at 1.5 and your image is 500px width, do the simple math 500 * 1.5 = 750. So you can choose a 750px image to replace your 500px one, and don't see any quality leak. More information are available if you read the case study here.

overflow - Boolean - see example

By default, the image is scaled to apply a parallax effect without any overflow on the layout - you can check the case study to have a better understanding. When overflow is set to true, the image will translate out of its natural flow (so it may overlap with your content).

delay - Number - see example

When a delay is set, the translation of the image will continue during that delay when the user stops scrolling. That gives a very nice effect. The delay is in second.

transition - String - see example

The transition setting works closely with the delay setting. This setting will add any CSS transition to the delay setting. For example you can use ease or ease-in-out.

customContainer - String or Node

By default, the parallax calculation is done with the body scroll percentage. In some cases, the images may be in a container that has its own scroll area, so to have an accurate calculation, the custom container should be set.

maxTransition - Number - see example

The maxTransition setting should be used to stop the parallax animation after a given percentage. By default, it translates from 0% to 100% of the user viewport. You can change it here to any percentage you want.

Methods

Destroy a simpleParallax instance:

var images = document.querySelectorAll('img');
var instance = new simpleParallax(images);
instance.destroy();

Examples

You can find all the examples here.

Compatibility

You can apply simpleParallax.js on picture tags along with srcset images.

Author

Geoffrey Signorato

Contributing

Open an issue or a pull request to suggest changes or additions.