🚀 🍦 Cross browser responsive smooth scrolling for entire web applications.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
src
unit
.gitattributes
.gitignore
.npmignore
.travis.yml
LICENSE
README.md
gulpfile.js
package.json

README.md

silk-scroll.js

Build Status npm version

Cross browser responsive smooth scrolling for entire web applications.

Demo

View example site

While there currently is no formal demo site, if you want to see silk-scroll in action feel free to check out my Tumblr page where I'm currently using silk-scroll.

Installation

Installing silk-scroll on the client side is simple. Just download the minified file of the latest version and include it in your webpage:

<!-- Include the silk-scroll file -->
<script src="path/to/silk-scroll.min.js"></script>

If you'd like to install silk-scroll on the server side using npm, it's as easy as:

npm install silk-scroll --save

Usage

To get the smooth scrolling ability on your webpage, all you need to do is include the minified file of the latest version in your application and then activate SilkScroll:

// SilkScroll will already be a global object
SilkScroll.active();

If you have silk-scroll installed on your Node application, you can use it on the server in Node like so:

const SilkScroll = require('silk-scroll');

SilkScroll.active();

License

MIT

Copyright (c) 2016 Nick Zuber