Giter Site home page Giter Site logo

animate-scroll-js's Introduction

AnimateScroll.js

Lightweight javascript library to animate vertical scrolling to a specified element without jQuery.

Click here for a demo

Usage

animateScroll(target, duration, easing, padding, align, onFinish)
  • target Specifies the DOM element, or a page offset value (px) to scroll to
  • duration How long the scroll animation lasts in milliseconds. Default: 0.
  • easing Easing type for scroll animation. See below for options Default: linear. (string)
  • padding How much space in pixels from the top of the specified element to scroll to. Default: 0
  • align Can be set to "top", "center", "bottom" and scroll will animate to the target aligned as specified within the window. Default "top" (string)
  • onFinish Callback function to run when the animation is finished or cancelled.

Easing

The types of easing available. Easing functions taken from: https://gist.github.com/gre/1650294

  • "linear"
  • "easeInQuad"
  • "easeOutQuad"
  • "easeInOutQuad"
  • "easeInCubic"
  • "easeOutCubic"
  • "easeInOutCubic"
  • "easeInQuart"
  • "easeOutQuart"
  • "easeInOutQuart"
  • "easeInQuint"
  • "easeOutQuint"
  • "easeInOutQuint"

Notes

  • If the user manually scrolls during the scroll animation, the animation will cancel and the onFinish function will run
  • Only the element argument is mandatory. Rest are optional with default values.
  • This was created after I couldn't find anywhere online a library that can scroll smoothly without jQuery

animate-scroll-js's People

Contributors

rolandtoth avatar sunmockyang avatar

Watchers

 avatar

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.