https://github.com/alexprut/simpleparallax.js

A Simple and light Parallax library
https://github.com/alexprut/simpleparallax.js

javascript javascript-plugin jquery jquery-plugin parallax

Last synced: 4 days ago
JSON representation

A Simple and light Parallax library

• Host: GitHub
• URL: https://github.com/alexprut/simpleparallax.js
• Owner: alexprut
• License: mit
• Created: 2017-05-03T18:45:28.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-06-08T16:54:28.000Z (over 4 years ago)
• Last Synced: 2024-11-10T19:19:46.387Z (6 days ago)
• Topics: javascript, javascript-plugin, jquery, jquery-plugin, parallax
• Language: HTML
• Homepage: http://alexprut.github.io/SimpleParallax.js
• Size: 1.17 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
SimpleParallax.js

=================

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) [![MIT](https://img.shields.io/dub/l/vibe-d.svg)](https://github.com/alexprut/SimpleParallax.js/blob/master/LICENSE)  

> A Simple and light Parallax library   

Live demo: [http://alexprut.github.io/SimpleParallax.js](http://alexprut.github.io/SimpleParallax.js)

![SimpleParallax.js](https://github.com/alexprut/SimpleParallax.js/raw/master/img/simpleparallax.gif)

##  Installation

* __Bower__:  

    Run from your console/terminal ```bower install simpleparallax.js --save```

* __From Source__:  

    Run ```git clone https://github.com/alexprut/SimpleParallax.js.git```

* __Direct download__:  

    Download the last version from [here](https://github.com/alexprut/SimpleParallax.js/archive/master.zip "download")

## Usage

```html



    


        example

    

    


        example

    



```


For a complete example see [index.html](https://github.com/alexprut/SimpleParallax.js/blob/staging/index.html)

#### Parameters

|Data Attribute|Type|Description|Default|

|----|----|-----------|-------|

|```data-parallax-scope```|```['global']```|the scope/region covered by the parallax effect|```'global'```|

|```data-parallax-axis```|```['both']```|the direction affected by the parallax effect|```'both'```|

|```data-parallax-detect```|```['mouseover']```|the event that triggers the effect|```'mouseover'```|

|```data-parallax-max-shift```|```int```|maximum shift in both directions of the elements|```1000```|

|```parallax-depth```|```int```|the depth of a item|```1```|

|```parallax-offset-x```|```int```|the offset of a item in pixels along the x axis|```0```|

|```parallax-offset-y```|```int```|the offset of a item in pixels along the y axis|```0```|

## License

SimpleParallax.js is licensed under the MIT License – see the LICENSE file for details.