cubic-scroll

Extremely lightweight modern implementation of scroll with easing effect based on cubic function and rendering based on requestAnimationFrame

Installation

Using npm

$ npm install cubic-scroll --save-dev 

or yarn

$ yarn add cubic-scroll

Basic usage

When there is scrollable view on the page

<script type="text/javascript">
  function clickHandler(e) {
    var sections = document.querySelector('.content').children;

    for (var i in Object.keys(sections)) {
      sections[i].className = '';
    }

    fluidScroll.handleLinkClick(e, {
      scrollView: document.querySelector('.content'),
      callback: function(targetEl) {
        targetEl.className = 'selected';
    }});
  }
</script>
<div class="menu">
  <a href="#section-0"
    onclick="clickHandler(event)">Link 0</a>
  <a href="#section-1"
    onclick="clickHandler(event)">Link 1</a>
  <a href="#section-2"
    onclick="clickHandler(event)">Link 2</a>
</div>
<div class="content">
  <div id="section-0">Section 0</div>
  <div id="section-1">Section 1</div>
  <div id="section-2">Section 2</div>
</div>

Here you can find full example of scrollable view, and for case when whole page is scrollable see Scrollable page

API

handleLinkClick

Scrolls to anchor, that is linked to event target. It has following parameters:

• e - DOM click event
• opts - configuration options
  • scrollView - scrollable view on the page, by default document body is used
  • marginTop - margin from the top of the scroll view, it is useful if you have sticky top menu
  • accelerateFactor - this parameter influences on the initial speed of scroll according to the formula speed = cbrt(y * accelerateFactor), default value is 40
  • callback - function that will be called after last animation frame, scroll target element will be passed as parameter, it is useful when you need to decorate it at the end of scroll, see examples scrollable page and scrollable view

scrollTo

Scrolls to passed anchor on the page. It has following parameters:

• targetEl - Target anchor DOM element
• opts - options, the same as for handleLinkClick