Code Monkey home page Code Monkey logo

motion-scroll's Introduction

motion-scroll

scroll to a position or an element with easing

Installation

npm install motion-scroll es6-easing

es6 easing documentation can be found here..
https://github.com/ninjabonsai/es6-easing

Basic usage

scroll to top of page

import MotionScroll from 'motion-scroll';
import { easeInQuadOutExpo } from 'es6-easing';

// scrolls to the top of the page at 2000px per second easing out
MotionScroll.scroll( {
    scrollTo: 0,
    speed: 2000,
    easing: easeInQuadOutExpo,
} );

scroll to a child element's position

MotionScroll.scroll( {
    scrollTo: document.querySelector( '#foo' ),
} );

scroll an element instead of the window

MotionScroll.scroll( {
    element: document.querySelector( '#bar' ),
} );

Config defaults

MotionScroll.scroll( {
    element: document.documentElement, // element to scroll
    axis: 'y', // scroll on the x or y axis ie- horizontal or vertical scrolling
    scrollTo: 0, // number or dom element
    speed: 2000, // speed in pixels per second
    easing: null, // if no easing function is provided animation will be linear
    callBack: null, // function to call when scrolling is complete
    delay: 0, // delay in seconds until scrolling begins
    force: false, // prevent mousewheel interaction from cancelling scroll
    minScrollTime: 0, // in seconds
    maxScrollTime: 10, // in seconds
} );

motion-scroll's People

Watchers

 avatar  avatar

Forkers

pmrotule

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.