/angular-parallax

Angular.js module for parallax goodness.

Primary LanguageHTMLMIT LicenseMIT

AngularJS Parallax

Angular Parallax

angular-parallax is an AngularJS module for providing parallax-like functionality for DOM elements

Heavily inspired by stellar.js.

Demos

Check out the demo here.

Version Numbers

Getting Started

  • View the source

  • Include the script tag on your page after the AngularJS tag

     <script type='text/javascript' src='path/to/angular.min.js'></script>
     <script type='text/javascript' src='path/to/angular-parallax.js'></script>
    
  • Ensure that your application module specifies angular-parallax` as a dependency:

     angular.module('myApplication', ['angular-parallax']);
    
  • Use the directive by specifying a parallax or parallax-background attribute on an element.

     <img parallax parallax-ratio="0.4" src="some/image.jpg" />
     <div parallax-background parallax-ratio="0.2"></div>
    

Detailed Documentation

angular-parallax accepts several attributes to customize the behavior of the directive; detailed instructions coming soon

License

angular-parallax is licensed under the MIT license. See the LICENSE file for more details.