npm.io
1.0.0 • Published 4 years ago

section-snap-scroller

Licence
BSD-3-Clause
Version
1.0.0
Deps
2
Size
38 kB
Vulns
0
Weekly
0

SectionSnapScroller.js

JavaScript based scroll handler to perform vertical snap scroll on page sections.

Installation

npm i section-snap-scroller

Usage

var $el = document.getElementById("main");
var scrollHandler = new SectionSnapScroller($el, {
	behavior: "mandatory", // "proximity"
	onSectionUpdate: function (sectionId) {
		// This is fired when the current section is updated
		console.log("Update scroll to " + sectionId);
	},
	beforeScroll: function (sectionId) {
		// This is fired once before scroll starts
		console.log("Before scroll from " + sectionId);
	},
	onScroll: function (sectionId) {
		// This is fired while scrolling
		console.log("While scrolling from " + sectionId);
	},
	afterScroll: function (sectionId) {
		// This is fired once when scroll ends
		console.log("After scroll to " + sectionId);
	},
});

Scroll Snap

This package reproduce the behavior of the CSS module Scroll Snap but handler by javascript and for non-touchable browsers where this CSS module works regular.