Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pixelcog/parallax.js
Simple parallax scrolling effect inspired by Spotify.com implemented as a jQuery plugin
https://github.com/pixelcog/parallax.js
Last synced: about 2 months ago
JSON representation
Simple parallax scrolling effect inspired by Spotify.com implemented as a jQuery plugin
- Host: GitHub
- URL: https://github.com/pixelcog/parallax.js
- Owner: pixelcog
- License: mit
- Created: 2014-06-08T20:26:43.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-05-11T11:39:51.000Z (over 2 years ago)
- Last Synced: 2024-05-19T05:30:39.998Z (4 months ago)
- Language: JavaScript
- Size: 1.22 MB
- Stars: 3,520
- Watchers: 114
- Forks: 847
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Parallax.js
===========
Simple parallax scrolling implemented as a jQuery plugin.
[http://pixelcog.com/parallax.js/](http://pixelcog.com/parallax.js/)
Please also check our [v2.0.0-alpha](https://github.com/pixelcog/parallax.js/tree/v2.0.0-alpha)! We'd be happy to receive your feedback!
**ATTENTION:** please use the issue tracker for bug reports and feature requests ONLY! For questions and topics which go along the lines "I cannot get this to work" please turn to [stackoverflow.com](https://stackoverflow.com/questions/tagged/parallax.js) for help and use the tag [parallax.js](https://stackoverflow.com/questions/tagged/parallax.js). Thank you for your understanding!
## Installation
### NPM
```bash
npm i --save jquery-parallax.js
```
### Yarn
```bash
yarn add jquery-parallax.js
```
### Bower
Please note that although Bower is still maintained, they recommend Yarn for new projects.
```bash
$ bower i --save parallax.js
```
### Setup
Include `parallax.min.js` in your document after including jQuery (compatible with jQuery >= 1.7).
```html
```
Use these CDN links, provided by jsDelivr.com
```html
```
## Usage
Please note, that `` on top of your document is required!
### Simple version via data attributes
*Note: for more complex requirements we recommend using the [inner HTML markup](#using-inner-html-for-complex-content) below! With that it's possible to use the parallax effect with almost any HTML content*
To easily add a parallax effect behind an element, add `data-parallax="scroll"` to the element you want to use, and specify an image with `data-image-src="/path/to/image.jpg"`.
```html
```
### Via JavaScript
To call the parallax plugin manually, simply select your target element with jQuery and do the following:
```javascript
$('.parallax-window').parallax({imageSrc: '/path/to/image.jpg'});
```
### Notes
What parallax.js will do is create a fixed-position element for each parallax image at the start of the document's body (or another configurable container). This mirror element will sit behind the other elements and match the position and dimensions of its target object.
Due to the nature of this implementation, you must ensure that these parallax objects and any layers below them are transparent so that you can see the parallax effect underneath. Also, if there is no other content in this element, you will need to ensure that it has some fixed dimensions otherwise you won't see anything.
```css
.parallax-window {
min-height: 400px;
background: transparent;
}
```
Also, keep in mind that once initialized, the parallax plugin presumes a fixed page layout unless it encounters a `scroll` or `resize` event. If you have a dynamic page in which another javascript method may alter the DOM, you must manually refresh the parallax effect with the following commands:
```javascript
jQuery(window).trigger('resize').trigger('scroll');
```
### Using inner HTML for complex content
You can use the following syntax to enable complex content for the parallax:
```html
```
Please note, that the div with class "parallax-slider" is essential here.
You then need to initialize it through JS and provide the naturalWidth and naturalHeight options in order to be rendered correctly.
```
$('.parallax-window').parallax({
naturalWidth: 600,
naturalHeight: 400
});
```
This also makes it possible to use responsive images in the slider:
```html
```
## Options
Options can be passed in via data attributes of JavaScript. For data attributes, append the option name to `data-`, as in `data-image-src=""`.
Note that when specifying these options as html data-attributes, you should convert "camelCased" variable names into "dash-separated" lower-case names (e.g. `zIndex` would be `data-z-index=""`).
Name
type
default
description
imageSrc
path
null
You must provide a path to the image you wish to apply to the parallax effect.
naturalWidth
number
auto
You can provide the natural width and natural height of an image to speed up loading and reduce error when determining the correct aspect ratio of the image.
naturalHeight
number
auto
position
xPos yPos
center center
This is analogous to the background-position css property. Specify coordinates as top, bottom, right, left, center, or pixel values (e.g. -10px 0px). The parallax image will be positioned as close to these values as possible while still covering the target element.
positionX
xPos
center
positionY
yPos
center
speed
float
0.2
The speed at which the parallax effect runs. 0.0 means the image will appear fixed in place, and 1.0 the image will flow at the same speed as the page content.
zIndex
number
-100
The z-index value of the fixed-position elements. By default these will be behind everything else on the page.
bleed
number
0
You can optionally set the parallax mirror element to extend a few pixels above and below the mirrored element. This can hide slow or stuttering scroll events in certain browsers.
iosFix
boolean
true
If true, this option will set the parallax image as a static, centered background image whenever it detects an iOS user agent. You also need to set iosDisabled option true to make this option works. Disable this if you wish to implement your own graceful degradation.
iosDisabled
boolean
true
If true, the parallax effect is disabled on iOS devices.
androidFix
boolean
true
If true, this option will set the parallax image as a static, centered background image whenever it detects an Android user agent. You also need to set androidDisabled option true to make this option works. Disable this if you wish to enable the parallax scrolling effect on Android devices.
androidDisabled
boolean
true
If true, the parallax effect is disabled on Android devices.
overScrollFix
boolean
false
(Experimental) If true, will freeze the parallax effect when "over scrolling" in browsers like Safari to prevent unexpected gaps caused by negative scroll positions.
mirrorContainer
jQuery Selector
body
The parallax mirror will be prepended into this container.
## Contributing
If you have a pull request you would like to submit, please ensure that you update the minified version of the library along with your code changes. This project uses [uglifyjs](https://www.npmjs.com/package/uglify-js) to perform code compression.
Please use the following command:
uglifyjs parallax.js --comments -m -c -o parallax.min.js
LICENSE
=======
The MIT License (MIT)
Copyright (c) 2016 PixelCog Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.