https://github.com/bluzi/overscroll
Detect Mac touchpad overscroll on browsers
https://github.com/bluzi/overscroll
javascript javascript-library macbook trackbar
Last synced: 3 months ago
JSON representation
Detect Mac touchpad overscroll on browsers
- Host: GitHub
- URL: https://github.com/bluzi/overscroll
- Owner: bluzi
- Created: 2017-09-23T13:29:25.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-10-27T21:48:48.000Z (almost 8 years ago)
- Last Synced: 2024-11-29T14:59:55.711Z (10 months ago)
- Topics: javascript, javascript-library, macbook, trackbar
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/overscrolljs
- Size: 8.79 KB
- Stars: 2
- Watchers: 3
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Overscroll JS
**What it does**: Overscroll detects when a user, using Apple's touchpad feature (Macbook Touchpad or Magic Touchpad), scrolls outside the bounds of a webpage. When they do Overscroll can fire a callback function in your application.
It's extremely lightweight, has no dependencies, and is less than 400 bytes when minified.
### Example:
```javascript
overscroll(() =>
console.log('Overscroll Detected')
);
```
## Installation
### Via jsDeliver (Recommended)
Add the following script tag to your HTML file:
```html
```
### Via NPM
Navigate to your project's directory and install the Overscroll, adding it to your package.json:
$ npm i -S overscrolljs
### Via Yarn
Navigate to your project's directory, and execute the following command:
$ yarn add overscrolljs
Then, embed the script in your HTML using a script tag:
```html
```
___
## Contributing
[Check for open issues](https://github.com/bluzi/overscroll/issues) or add your own features by starting a pull request.
## Author
Eliran Pe'er - @bluzi
## License
This project is licensed under the MIT License.