Jquery-offset-scroller

A jQuery plugin to enable smooth scrolling to a page anchor/id with a configurable offset.

Download .zip Download .tar.gz View on GitHub

jquery-offset-scroller

A jQuery plugin to enable smooth scrolling to a page anchor/id with a configurable offset.

An offset can be helpful for pages with a fixed position header.

Demo

See the Pen jQuery offsetScroller by Mason Hale (@masonhale) on CodePen.

Options

  • offsetPixels - subtracted from target position. Default: 0
  • animationSpeed - milliseconds to reach target. Default: 500

Usage

<script>
  $(document).ready(function() {
     // update offsetPixels default to account for fixed position header
     $().offsetScroller.defaults.offsetPixels = 92;
     
     // add scroller for all '#anchor' links
     $('a[href*="#"]:not([href="#"])').offsetScroller();
     
     // auto scroll to #hash location on page load
     $().offsetScroller.scrollToHash(window.location.hash);
  });
</script>

License

MIT License