Skip to content

Latest commit

 

History

History
67 lines (41 loc) · 1.72 KB

README.md

File metadata and controls

67 lines (41 loc) · 1.72 KB

Smart, Super smooth, cross-browser, and easy-to-use parallax scrolling effect plugin you have ever seen!

Scrollax.js features:

  • Highly optimized scrolling rendering
  • GPU accelerated
  • Set custom ratio for any CSS property
  • Don't parallax elments that are not in the viewport
  • Horizontal & Vertical scrolling supports
  • Lots of super useful methods

... and has a powerful & developer friendly API!

That's all build around a custom highly optimized scrolling rendering, and GPU accelerated.

Dependencies

  • jQuery 1.7+

Compatibility

Works everywhere, even in IE6+ abominations, but that is a complete accident :) IE 6-7 are not officially supported.

Usage

Constructor:

var frame = new Scrollax(window).init();

jQuery proxy:

$(window).Scrollax();

or

$.Scrollax();

jQuery proxy is good when you want to create an instance and forget about it. For anything more complex, like using methods, events, accessing instance properties, ... use the constructor and work with the instance directly.

Download

Latest stable release:

When isolating issues on jsfiddle, you can use this URL:

Documentation

Can be found in the docs directory.

Contributing

Please, read the Contributing Guidelines for this project.

License

MIT