scrolltobyspeed's Introduction

scrollToBySpeed

It seems whack to choose a duration when animating window scrolling to the position of an element. That element might be close by causing a super slow scroll. It also might be far away causing the window to scroll at warp speed.

This plugin let's you scroll the window by speed rather than by duration.

Usage

Include the plugin on your page or compile it into your libraries.

<script src="scrolltobyspeed.jquery.js"></script>

Now when we want the window to scroll we give it a speed rather than a duration.

$('#element').scrollToBySpeed({
  speed: 1000
});

We can also add an offset to the destination scroll position.

$('#element').scrollToBySpeed({
  speed: 1000,
  offset: -100
});

Set the easing if desired.

$('#element').scrollToBySpeed({
  easing: 'linear'
});

The default scrolling context is the entire window. To scroll within another scrollable element specify the context as either a selector string or a jQuery object.

$('#element').scrollToBySpeed({
  context: '.foo'
});

If custom easing or callbacks are desired, use the plugin to get the duration and animate manually.

function () {
  var $element = $('#element'),
      duration = $element.scrollToBySpeed({mode:'duration'});

  ...
}

Bower

This plugin is available via Bower.

bower install scrollToBySpeed

Contributing

Everyone is welcome to open issues or make pull requests.

Versions

v0.3.0 2014-07-18
- Thanks to @cdCorey for adding scrolling context
v0.2.1 2014-04-07
- Add easing option
v0.2.0 2014-04-07
- Don't handle event binding, just the scrolling
- Allow return of duration
v0.1.0 2014-04-01
- Initial