simple-parallax-js
Advanced tools
simpleParallax is a simple and lightweight JS plugin that gives your website parallax animations on the images
simpleParallax is a very simple and lightweight Vanilla JS 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!
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@4.1.0/dist/simpleParallax.min.js"></script>
or
#npm
npm install simple-parallax-js
#yarn
yarn add simple-parallax-js
Then you can simply import it:
import simpleParallax from 'simple-parallax-js';
Giving the following HTML:
<img class="thumbnail" src="image.jpg" alt="image">
Simply add the following JS code:
var images = document.getElementsByClassName('thumbnail');
var instances = new simpleParallax(images);
// or
var instance = new simpleParallax(images[0]);
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 JS code:
var images = document.querySelectorAll('.thumbnail');
new simpleParallax(images, {
delay: 0,
orientation: 'down',
scale: 1.30,
overfow: true
});
destroy a single instance
instance.destroy();
destroy several instances
instances.forEach(instance => instance.destroy());
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
Open an issue or a pull request to suggest changes or additions.
FAQs
simpleParallax.js is a lightweight and easy-to-use JS library that adds parallax animations to any image.
The npm package simple-parallax-js receives a total of 8,347 weekly downloads. As such, simple-parallax-js popularity was classified as popular.
We found that simple-parallax-js demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.