bloody-scroll

Smooth scrolling to given coordinates for the browser

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
bloody-scroll
5011.0.17 years ago9 years agoMinified + gzip package size for bloody-scroll in KB

Readme

bloody-scroll
Smooth scrolling to given coordinates for the browser

Build Status

Install

$ npm install --save bloody-scroll

Import

import scroll from "bloody-scroll"

API

promise scroll({ x: number, y: number}, duration = 300)

Arguments

  • coords.x : (Number) Horizontal target for scroll.
  • coords.y : (Number) Vertical target for scroll.
  • duration : (Number) Transition duration.

Returns

  • promise : (Promise) A promise that is fulfilled once the transition is done.

Example

scroll({ x: 0, y: 1000 }, 1000)
scroll({ x: 1000 }, 1000)
scroll({ y: 400 }, 1000)