https://github.com/mattiashaal/smoothy
A smooth-scroll plugin running with average speed or a set time.
https://github.com/mattiashaal/smoothy
smooth-scroll-plugins smooth-scrolling smoothy
Last synced: 4 months ago
JSON representation
A smooth-scroll plugin running with average speed or a set time.
- Host: GitHub
- URL: https://github.com/mattiashaal/smoothy
- Owner: mattiashaal
- License: mit
- Created: 2016-06-21T16:28:36.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2018-04-25T10:59:25.000Z (about 8 years ago)
- Last Synced: 2026-02-15T00:27:30.245Z (4 months ago)
- Topics: smooth-scroll-plugins, smooth-scrolling, smoothy
- Language: JavaScript
- Homepage: https://mattiashaal.github.io/smoothy/
- Size: 655 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Smoothy
Most smooth-scroll plugins out there are running on a set time. Which sometimes can behave badly if the distance is very short, results in mega slow scroll, or very long, results in mega fast scroll. Smoothy takes care of this by having settings for average speed and set time. Select animation type after your needs.
## Getting Started
1. [Install](#install)
2. [Include script](#include-script)
3. [Include markup](#include-markup)
4. [Settings](#settings)
5. [Demo](https://kaloja.github.io/smoothy/)
## Install
```sh
# via npm:
$ npm install smoothy
# via git clone:
$ git clone https://github.com/kaloja/smoothy
```
## Include script
Ensure you're using the file in the `dist` directory, which contains compiled production-ready code. Place the script before the closing `