README
Slickscroll is a JavaScript library that makes momentum & parallax scrolling quick and painless
View Demo: slickscroll.musabhassan.com
Momentum Scrolling
Momentum Scrolling is the smooth and eased scrolling fancy websites have to allow the page to flow smoothly when scrolling.
Download & Setup
Download
Manually download from Releases, from the dist
directory, or npm.
npm
npm install --save slickscrolljs
Setup
ES6 import
import slickScroll from 'slickscroll.es.min.js';
const slick = new slickScroll;
HTML script tag
<script src="slickscroll.min.js"></script>
<script type="text/javascript">
var slick = new slickScroll.default;
</script>
Node require
const slickScroll = require('slickscrolljs');
const slick = new slickScroll.default;
Hello World
The hello world will apply the momentum scrolling to the element you specify.
slick.momentumScroll({
root: "body"
})
The overflow property will be overridden with auto
upon initialization. If you wish to change overflow to anything else, you must modify it after the initialization. Here is an example to hide overflow-x.
slick.momentumScroll({
root: "body"
});
document.querySelector("body").style.overflowX = "hidden";
All the valid options aswell as documentation and Getting Started can be found in the docs
directory.
Browser Support
Browser | Version | - | - | Chrome | 61+ Edge | 80+ IE | None Firefox | 48+ Opera | 48+ Safari | 13+
Contributors
Musab-Hassan
License
MIT license.