jQuery plugin to apply parallax effects on images
Clone or download
Latest commit 34521cf Oct 12, 2018

README.md

simpleParallax logo

GitHub version code style: prettier

Why use simpleParallax?

simpleParallax is a very simple and lightweight jQuery plugin that improve your website with parallax animations on your images.

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

Any image will fit. Try it out!

How to use it?

1. Install the plugin

Make sure jQuery library is loaded before the plugin.

Copy/paste

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

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

or use the below CDN link provided by jsDelivr.com

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/simple-parallax-jquery@3.1.3/dist/simpleParallax.min.js"></script>

or

Install it via Package Managers

#npm
npm install simple-parallax-jquery

#yarn
yarn add simple-parallax-jquery

2. Initialize the plugin

Giving the following HTML:

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

Simply add the following jQuery code:

$('.thumbnail').simpleParallax();

3. Settings

Find below the different settings you can apply to simpleParallax:

setting default
delay 0.6 add some delay for parallax animations - in second
orientation up choose the parallax orientation effect - up, right, down or left
scale 1.2 choose the scale ratio - need to be above 1.0
overflow false by default, the image is scaled to apply a parallax effect without any overflow on the original image container. If overflow is set to true, the image will be translated out of its natural flow without any scale.
transition cubic-bezier(0,0,0,1) choose the css transition (will work only if delay is different that 0) - ease, linear, ease-in, etc.
breakpoint false choose the minimum breakpoint (in pixel) where simpleParallax will be initialized - 768

You can apply these settings with the following jQuery code:

$('img').simpleParallax({delay: 0, orientation: 'down', scale: 1.30, overfow: true });

4. Methods

Find below the different methods you can use:

destroy

$('.thumbnail').data('simpleParallax').destroy();

Good to know

  • The higher the scale setting is set, the more visible the parallax effect will be. In return, the image will lose in quality (no loss of quality if overlow option is set to false)

  • This plugin apply parallax on the image tag and not the background image. This gives you a lot of flexibility and can be added to any image.

  • You can apply simpleParallax on picture/srcset images

Author

Geoffrey Signorato

Contributing

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