⇤⇥ Snap page when user stops scrolling, with a customizable configuration and a consistent cross browser behaviour
Switch branches/tags
Nothing to show
Clone or download
lucafalasco Merge pull request #3 from dasilvacontin/patch-1
Fix potentially incorrect condition
Latest commit a159a4a Dec 1, 2018

README.md

scroll-snap

npm npm version npm downloads

Snap page when user stops scrolling, basically implements CSS Scroll Snap Points, but with a customizable configuration and a consistent cross browser behaviour.

  • works in all modern browsers
  • requestAnimationFrame for 60fps
  • customizable configuration
  • no additional libraries
  • no extra stylesheet

Installation

npm install scroll-snap --save

or

yarn add scroll-snap

You can also grab a pre-built version from unpkg

Usage

Just call the constructor passing a DOM element and a configuration object as parameters, then use:

bind() to initialize the scroll snap and bind the listener, accepts an optional callback as parameter to execute once the animation ends.

unbind() to remove the listener.

Check out the following code:

import ScrollSnap from 'scroll-snap'

const snapConfig = {
  scrollSnapDestination: '90% 0%', // *REQUIRED* scroll-snap-destination css property, as defined here: https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-snap-destination
  scrollTimeout: 100, // *OPTIONAL* (default = 100) time in ms after which scrolling is considered finished
  scrollTime: 300 // *OPTIONAL* (default = 300) time in ms for the smooth snap
}

function callback () {
  console.log('called when snap animation ends')
}

const element = document.getElementById('container')
const snapObject = new ScrollSnap(element, snapConfig)

snapObject.bind(callback)

// unbind the element
// snapObject.unbind();

Here you can see a working demo.

Contributing

git clone https://github.com/lucafalasco/scroll-snap.git
cd scroll-snap
npm install

Start the test app from demo/ and fire up the dev server

npm start

Build for production:

npm run build

License

MIT