simpleParallax

Simple and tiny JavaScript library that adds parallax animations on any ima...

Scrolling
geosigno/simpleParallax.jssimpleparallax.comsimple-parallax-js

README

simpleParallax logo
GitHub version Only 32 Kb undefined GitHub issues undefined 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 `` tag :
  1. ``` html
  2. <script src="simpleParallax.js"></script>
  3. ```
or use the below CDN link provided by jsDelivr.com :
  1. ``` html
  2. <script src="https://cdn.jsdelivr.net/npm/simple-parallax-js@5.6.1/dist/simpleParallax.min.js"></script>
  3. ```

Via npm/yarn

You can also install it via :
  1. ```sh
  2. #npm
  3. npm install simple-parallax-js
  5. #yarn
  6. yarn add simple-parallax-js
  7. ```
and then import it as follows :
  1. ``` js
  2. //ES6 import
  3. import simpleParallax from 'simple-parallax-js';
  5. //CommonJS
  6. const simpleParallax = require('simple-parallax-js');
  7. ```

Initialization

Giving the following HTML :
  1. ``` html
  2.  <img class="thumbnail" src="image.jpg" alt="image">
  3. ```
simply add the following JavaScript code :
  1. ``` js
  2. const image = document.getElementsByClassName('thumbnail');
  3. new simpleParallax(image);
  4. ```
and voilà!
___
You can also choose to apply the parallax on multiple images :
  1. ``` js
  2. const images = document.querySelectorAll('img');
  3. new simpleParallax(images);
  4. ```
Once simpleparallax has been correctly initialized, it adds the simple-parallax-initialized class on the container.
simpleParallax now works with video :
  1. ``` html
  2. <video>
  3.   <source src="video.mp4" type="video/mp4">
  4. </video>
  5. ```
  1. ``` js
  2. var video = document.getElementsByTagName('video');
  3. new simpleParallax(video);
  4. ```

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 | the delay is in second Watch out, sometimes this delay is causing issue on iOS devices #47
transition | String | '' | any CSS transition
customContainer | String or Node | '' |  
customWrapper | String | '' | the selector of the custom wrapper
maxTransition | Number | 0 | it should be a percentage between 1 and 99
You can apply these settings with the following JS code :
  1. ``` js
  2. var images = document.querySelectorAll('.thumbnail');
  3. new simpleParallax(images, {
  4.     delay: 0,
  5.     orientation: 'down',
  6.     scale: 1.3,
  7.     overflow: true,
  8.     customContainer: '.container',
  9.     customWrapper: '.wrapper'
  10. });
  11. ```

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 applies 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 is 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. Whenoverflow 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. Watch out, sometimes this delay is causing issue on iOS devices #47

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.

customWrapper - String

In some cases, you want to use your own wrapper instead of the one created by the plugin. If you specify your custom wrapper, the plugin will add the "simpleParallax" class along with an "overflow: hidden" style.

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

refresh

Refresh a simpleParallax instance (to recalculate all the positions) :  
  1. ``` js
  2. var images = document.querySelectorAll('img');
  3. var instance = new simpleParallax(images);
  4. instance.refresh();
  5. ```
By default, the refresh method is fired at every window resize.

destroy

Destroy a simpleParallax instance:
  1. ``` js
  2. var images = document.querySelectorAll('img');
  3. var instance = new simpleParallax(images);
  4. instance.destroy();
  5. ```

Examples

You can find all the examples here.

Compatibility

IEEdgeFirefoxChromeSafariOperaiOS
|---|---|---|---|---|---|---|
no16+55+58+12.1+45+12.2+
Even though old browsers are not supported, the page won't crash. Simply, there will be no parallax.
If you want to support older browsers such as IE, you will need a polyfill for cloest() and Intersection Observer. Please note that even with polyfills, the parallax effect will not seem fluid.

Author

Geoffrey Signorato

Contributing

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