node package manager
Orgs are free. Discover, share, and reuse code in your team. Create a free org »

stroller

Linotype Build Status NPM version

A collection of CSS list scroll effects. Works in browsers with support for CSS 3D transforms including a special touch-enabled mode for iOS & Android 4.x.

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 stroll.unbind():

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

History

1.2 (master/beta)

  • Mobile support (iOS/Android 4+)
  • New effects

1.1

  • Optimizations
  • New API
  • New effects

1.0

  • Initial release

Contributors

License

MIT licensed

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