parallax-background
Create captivating parallax backgrounds effortlessly with the ParallaxBackground plugin. This lightweight Vanilla JavaScript plugin, powered by GSAP animation, supports Scroll, Mouse Move, and Gyroscope events. Choose from Rotate or Shifting animations, and easily configure zoom and animation duration for a personalized touch.
Features:
- Vanilla JavaScript and GSAP powered
- Scroll, Mouse Move, Gyroscope events
- Rotate or Shifting animations
- Customizable zoom and animation duration
Demo
Basic demo
Events types and animation types demo
Package Managers
npm install parallax_background
Installation
Include js
<script src="https://cdnjs.cloudflare.com/ajax/libs/gsap/3.10.4/gsap.min.js"></script>
<script src="parallaxBackground.umd.js"></script>
Set HTML
<div class="parallax-background">
<div class="parallax-inner" style="background-image: url('https://placekitten.com/1280/720')">
</div>
</div>
Call the plugin
<script type="text/javascript">
new ParallaxBackground(document.querySelector(".parallax-background"));
$(document).ready(function() {
$('.parallax-background').parallaxBackground();
});
</script>
In result
<html>
<head>
<title>My website</title>
</head>
<body>
<div class="parallax-background">
<div class="parallax-inner" style="background-image: url('https://placekitten.com/1280/720')">
</div>
</div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/gsap/3.10.4/gsap.min.js"></script>
//optional for jQuery initialize
<script src="https://code.jquery.com/jquery-3.7.1.js"></script>
<script src="parallaxBackground.umd.js"></script>
<script type="text/javascript">
new ParallaxBackground(document.querySelector(".parallax-background"));
$(document).ready(function() {
$('.parallax-background').parallaxBackground();
});
</script>
</body>
</html>
Data Attribute Settings
In parallax-background you can add settings using the data-parallax-background attribute. You still need to call
new ParallaxBackground(selector)
to initialize parallax-background on the element.
Example:
<div class="parallax-background" data-parallax-background='{"duration": 3, "zoom": 30}'>
<div class="parallax-inner" style="background-image: url('background-image.jpg')">
</div>
</div>
Settings
Option | Type | Default |
---|
events | [SCROLL, MOUSE, GYRO] | [SCROLL] |
animationType | SHIFT | ROTATE | SHIFT |
zoom | int | 20 |
rotatePerspective | int | 1400 |
animateDuration | int | 1 |
Browser support
Dependencies
- GSAP animation library (Version 3.10.4)
Contributing
If you'd like to get involved, please consider opening an issue or submitting a pull request. Your input is highly valued, and I'm enthusiastic about collaborating to enhance this tool.
License
parallax-background is released under the MIT License. See the LICENSE file for comprehensive details regarding the terms and conditions of use.