Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 1.45 KB

README.md

File metadata and controls

49 lines (33 loc) · 1.45 KB

stroll.js – because it scrolls, and trolls.

A collection of CSS list scroll effects. Pull requests welcome!

Curious about how this looks in action? Check out the demo page.

Usage

The style of scroll effect is determined via the class that is set on the list. Once the class is set, stroll.js needs to be told to monitor that list via the bind method:

// Bind via selectors
stroll.bind( '#main ul' );

// Bind via element reference
stroll.bind( document.getElementById( 'some-list' ) );

// Bind via array of elements / jQuery object
stroll.bind( $( '#main .some-list' ) );

You can provide an additional parameter with more options:

// Makes stroll.js monitor changes to the DOM (like adding or resizing items). 
// This is taxing on performance so use scarcely. Defaults to false.
stroll.bind( '#main ul', { live: true } );

To disable the effect on an already bound list you can use the unbind method:

// Same target options as stroll.bind
stroll.unbind( selector/element/array );

Contributors

License

MIT licensed

Copyright (C) 2011 Hakim El Hattab, http://hakim.se