parallax_background
Advanced tools
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:
Basic demo
Events types and animation types demo
# NPM
npm install parallax_background
<script src="https://cdnjs.cloudflare.com/ajax/libs/gsap/3.10.4/gsap.min.js"></script>
<script src="parallaxBackground.umd.js"></script>
<div class="parallax-background">
<div class="parallax-inner" style="background-image: url('https://placekitten.com/1280/720')">
</div>
</div>
<script type="text/javascript">
//Initialize with Vanilla JavaScript
new ParallaxBackground(document.querySelector(".parallax-background"));
//Initialize with jQuery
$(document).ready(function() {
$('.parallax-background').parallaxBackground();
});
</script>
<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">
//Initialize with Vanilla JavaScript
new ParallaxBackground(document.querySelector(".parallax-background"));
//Initialize with jQuery
$(document).ready(function() {
$('.parallax-background').parallaxBackground();
});
</script>
</body>
</html>
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>
| Option | Type | Default |
|---|---|---|
| events | [SCROLL, MOUSE, GYRO] | [SCROLL] |
| animationType | SHIFT | ROTATE | SHIFT |
| zoom | int | 20 |
| rotatePerspective | int | 1400 |
| animateDuration | int | 1 |
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.
parallax-background is released under the MIT License. See the LICENSE file for comprehensive details regarding the terms and conditions of use.
FAQs
VanillaJS parallax background plugin
The npm package parallax_background receives a total of 0 weekly downloads. As such, parallax_background popularity was classified as not popular.
We found that parallax_background demonstrated a not healthy version release cadence and project activity because the last version was released 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
Create React App is officially deprecated due to React 19 issues and lack of maintenance—developers should switch to Vite or other modern alternatives.
Security News
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
Security News
The Linux Foundation is warning open source developers that compliance with global sanctions is mandatory, highlighting legal risks and restrictions on contributions.