parallax-vanilla v1.2.3
parallax-vanilla.js
Seamless and lightweight parallax scrolling library implemented in pure JavaScript utilizing Hardware acceleration for extra performance.
Demo
Main features
Super lightweight without dependencies
A few kilobytes of pure JavaScript.
Viewport-only animations
Parallax elements are only animated within the current viewport, saving a lot of resources.
Dynamic sizing
Image-elements are dynamically sized and adjusted relative to the pv-speed.
Performance is key
Vanilla Parallax maximizes your parallax effects with hardware acceleration and zero external libraries.
Media type independence
The parallax effect applies not only on images but on videos as well. Videos' audio will play if the videos are clicked and remain within the viewport.
Browser support
Tested browsers:
| Chrome | Safari | Firefox |
|---|---|---|
| 60+ | 10+ | 44+ |
Installation
bower
bower i --save parallax-vanillanpm
npm i --save parallax-vanillaInclude
- Include
parallax-vanilla.cssin<head> - Include
parallax-vanilla.jsjust before<body>
<link href="path/to/parallax-vanilla.css" />
<script src="path/to/parallax-vanilla.js"></script>Usage
Simple usage
1. Wrap a pv-block with a pv-container.
<div class="pv-container">
<div class="pv-block"></div>
</div>2. Attach a mediapath to pv-block
<div class='pv-container'>
<div class='pv-block' pv-mediapath=path/to/file.extension></div>
</div>3. Initialize library.
<div class='pv-container'>
<div class='pv-block' pv-mediapath=path/to/file.extension></div>></div>
</div>
<script>
pv.init()
</script>JavaScript initialization options
Optional global settings can be configured upon initialization.
pv.init({
container: {
class: String,
height: String || Number,
},
block: {
class: String,
speed: Number || Float,
mediapath: String,
mediatype: String,
mute: Boolean,
},
})JavaScript Settings
Data attributes: Customize individual elements
Data attributes allow fine control over each individual element and will overwrite the global JavaScript settings.
<div class='pv-container' pv-height=100vh>
<div class='pv-block' pv-speed=3.14 pv-mediatype=video pv-mediapath=path/to/epic_montage.mp4 pv-mute=false></div>
</div>This code will produce a container with class pv-container with height 100vh containing a block with class pv-block with a parallax speed of 3.14 displaying the media epic_montage.mp4 of type video with pv-mute=false.
The descriptions and the default values are the same as the corresponding properties of the JavaScript settings object.
CSS
The CSS in parallax-vanilla.css is required in order for parallax-vanilla to function properly.
.pv-container {
...;
}
.pv-container .pv-block {
...;
}
.pv-container .pv-block video {
...;
}
.audio-icon {
...;
}LICENSE
MIT