Skip to content

jetradar/scrollTo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 

Repository files navigation

scrollTo

Simple pure javascript smooth scrolling to element


This script exports two modules, scrollToTop and scrollTo, which can then be imported using the JS import statement currently available in Traceur, Babel, or Rollup.

Install

npm install scrollyo --save

With a "y".

Usage

First import the modules you need:

// Both
import {scrollToTop, scrollTo} from 'scrollyo';
// Just one
import {scrollTo} from 'scrollyo';

You can now use scrollToTop and/or scrollTo:

  • scrollToTop scrolls to the top of the page. Takes one argument for the timeout in miliseconds.

    scrollToTop(700);
  • scrollTo scrolls to any element in the DOM unless the element is already at the scrollTo position. The function takes two arguments: the element and a timeout in miliseconds (both mandatory).

    const myElement = document.querySelector('...');
    scrollTo(myElement, 700);

About

Simple pure javascript smooth scrolling to element

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published