0.0.8 • Published 7 years ago

slick-scroll v0.0.8

Weekly downloads
3
License
MIT
Repository
github
Last release
7 years ago

slick-scroll

Demos

Demos

Credit:

@shunryu111 http://stackoverflow.com/users/2630316/shunryu111

Based on:

http://stackoverflow.com/a/26798337/5068410

install

npm install slick-scroll --save

usage

import Scroller from 'slick-scroll';
// OR
const Scroller = require('slick-scroll');

// window
const windowScroller = new Scroller({
    speed: 1000
})

// Container
const container = document.getElementById('rolling');

const containerScroller = new Scroller({
    element: container,
    speed: 1000
})

myScroller.to(500).scroll()
myScroller.to(500).setSpeed(700).scroll()
myScroller.to(500).setEasing('easeOutSine').scroll();
myScroller.to(500).setSpeed(700).setEasing('easeInOutSine').scroll();

// Element in the DOM
myScroller.to(element).scroll()
myScroller.to(element).speed(700).scroll()
myScroller.to(element).easing('easeInOutQuint').scroll();
myScroller.to(element).speed(700).easing('easeInOutQuint').scroll();

// Save the scroller and use whenever you need
const scrollToTop = myScroller.to(0).speed(700).easing('easeInOutQuint');
scrollToTop.scroll()

const menu = document.getElementById('menu');
const scrollToMenu = myScroller.to(menu).speed(700).easing('easeOutSine');
scrollToMenu.scroll()

Options : object

Kind: global typedef Properties

NameTypeDefault
elementElementwindow
speednumber500
easingstring"'easeOutSine'"

Scroller

scroller.setSpeed(speed) ⇒ this

Sets the scroll speed

Kind: instance method of Scroller

ParamType
speednumber

scroller.setEasing(easing) ⇒ this

Sets the scroll easing function

Kind: instance method of Scroller

ParamType
easingstring

scroller.to(to) ⇒ this

Sets the scroll to

Kind: instance method of Scroller

ParamType
toElement | number

scroller.scroll(onSuccess, onFailure)

Scroll

Kind: instance method of Scroller

ParamTypeDefaultDescription
onSuccessfunction() => {}callback function when finish to scroll
onFailurefunction() => {}callback function when failed to scroll

Scroller.Scroller

Kind: static class of Scroller

new Scroller(options)

Creates an instance of Scroller.

ParamType
optionsOptions
0.0.8

7 years ago

0.0.7

7 years ago

0.0.6

7 years ago

0.0.5

7 years ago

0.0.4

7 years ago

0.0.3

7 years ago

0.0.2

7 years ago

0.0.1

7 years ago