https://github.com/mystroken/s

A custom scroll event library. Vanilla JS - No dependencies.
https://github.com/mystroken/s

custom-scroll scroll

Last synced: about 1 month ago
JSON representation

A custom scroll event library. Vanilla JS - No dependencies.

• Host: GitHub
• URL: https://github.com/mystroken/s
• Owner: mystroken
• License: mit
• Created: 2019-08-26T13:57:25.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-06-20T18:47:18.000Z (over 4 years ago)
• Last Synced: 2024-11-10T22:49:44.459Z (about 2 months ago)
• Topics: custom-scroll, scroll
• Language: JavaScript
• Homepage:
• Size: 13.7 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# :surfer: S

![npm bundle size](https://img.shields.io/bundlephobia/minzip/@mystroken/s)

![npm](https://img.shields.io/npm/dw/@mystroken/s)

![npm](https://img.shields.io/npm/v/@mystroken/s)

![GitHub last commit](https://img.shields.io/github/last-commit/mystroken/s)

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/mystroken/s/issues)

> S is a JavaScript library that allows you to implement custom scroll events.
This is a fork of Bartek Drozdz [VirtualScroll util](http://www.everyday3d.com/blog/index.php/2014/08/18/smooth-scrolling-with-virtualscroll/) and weighs ~1.5KB (minified and compressed).




### :tada: Goals of the fork

- Easier to add in a CommonJS environment

- Enable to create several distinct instances by using a prototype rather than a singleton




## Installation

```bash

npm install @mystroken/s

```

## Usage & API

- `new S(options)`

Return a new instance of S. See the options below.

- `instance.on(fn)`

Listen to the scroll event using the specified function (fn).

- `instance.off(fn)`

Remove the listener.

- `instance.destroy()`

Will remove all events and unbind the DOM listeners.

## Options

- **el**: the target element for mobile touch events. *Defaults to window.*

- **mouseMultiplier**: General multiplier for all mousewheel (including Firefox). *Default to 1.*

- **touchMultiplier**: Mutiply the touch action by this modifier to make scroll faster than finger movement. *Defaults to 2.*

- **firefoxMultiplier**: Firefox on Windows needs a boost, since scrolling is very slow. *Defaults to 15.*

- **keyStep**: How many pixels to move with each key press. *Defaults to 120.*

- **preventTouch**: If true, automatically call e.preventDefault on touchMove. Defaults to false.