# @livelybone/mouse-wheel

> A module for bind mouse-wheel event. typescript supported

Latest version **4.2.1** (published 2020-05-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @livelybone/mouse-wheel
pnpm add @livelybone/mouse-wheel
yarn add @livelybone/mouse-wheel
bun add @livelybone/mouse-wheel
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.2.1 |
| Published | 2020-05-16 |
| First published | 2018-07-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 16.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | 2631541504@qq.com |
| Maintainers | livelybone |
| Keywords | mouse wheel, wheel start, wheel end, convert delta by deltaMode |

## Links

- npm: https://www.npmjs.com/package/@livelybone/mouse-wheel
- Repository: https://github.com/livelybone/mouse-wheel
- Homepage: https://github.com/livelybone/mouse-wheel#readme
- Issues: https://github.com/livelybone/mouse-wheel/issues
- npm.io page: https://npm.io/package/@livelybone/mouse-wheel

## Recent versions

- 4.2.1 (latest) — 2020-05-16
- 4.2.0 — 2020-05-16
- 4.1.0 — 2019-07-30
- 4.0.3 — 2019-07-20
- 4.0.2 — 2019-07-20
- 4.0.1 — 2019-07-20
- 4.0.0 — 2019-07-20
- 3.2.0 — 2018-12-28
- 3.1.3 — 2018-09-13
- 3.1.2 — 2018-09-13
- 3.1.1 — 2018-09-13
- 3.1.0 — 2018-09-05
- 3.0.0 — 2018-09-05
- 3.0.0-beta1 — 2018-09-04
- 3.0.0-beta0 — 2018-09-04
- … 11 more at https://npm.io/package/@livelybone/mouse-wheel/versions

## README

# @livelybone/mouse-wheel
[![NPM Version](http://img.shields.io/npm/v/@livelybone/mouse-wheel.svg?style=flat-square)](https://www.npmjs.com/package/@livelybone/mouse-wheel)
[![Download Month](http://img.shields.io/npm/dm/@livelybone/mouse-wheel.svg?style=flat-square)](https://www.npmjs.com/package/@livelybone/mouse-wheel)
![gzip with dependencies: kb](https://img.shields.io/badge/gzip--with--dependencies-kb-brightgreen.svg "gzip with dependencies: kb")
![typescript](https://img.shields.io/badge/typescript-supported-blue.svg "typescript")
![pkg.module](https://img.shields.io/badge/pkg.module-supported-blue.svg "pkg.module")

> `pkg.module supported`, which means that you can apply tree-shaking in you project

[中文文档](./README-CN.md)

A module for bind mouse-wheel event. typescript supported

## repository
https://github.com/livelybone/mouse-wheel.git

## Demo
https://github.com/livelybone/mouse-wheel#readme

## Run Example
you can see the usage by run the example of the module, here is the step:

1. Clone the library `git clone https://github.com/livelybone/mouse-wheel.git`
2. Go to the directory `cd your-module-directory`
3. Install npm dependencies `npm i`(use taobao registry: `npm i --registry=http://registry.npm.taobao.org`)
4. Open service `npm run dev`
5. See the example(usually is `http://127.0.0.1:3000/examples/test.html`) in your browser

## Installation
```bash
npm i -S @livelybone/mouse-wheel
```

## Global name - The variable the module exported in `umd` bundle
`MouseWheel`

## Interface
See what method or params you can use in [index.d.ts](./index.d.ts)

## Usage
```typescript
import { bind, BindOptions, CustomListener, CustomWheelEvent } from '@livelybone/mouse-wheel'

let unbind

const listener: CustomListener = (event: CustomWheelEvent) => {}

const options: BindOptions = {}

// Bind on element
unbind = bind(document.getElementById('id'), listener, options)

// Unbind
unbind()

// Bind on window
unbind = bind(listener, options)

// Unbind
unbind()
```

## CDN
Use in html, see what you can use in [CDN: unpkg](https://unpkg.com/@livelybone/mouse-wheel/lib/umd/)
```html
<-- use what you want -->
<script src="https://unpkg.com/@livelybone/mouse-wheel/lib/umd/<--module-->.js"></script>
```

Or，see what you can use in [CDN: jsdelivr](https://cdn.jsdelivr.net/npm/@livelybone/mouse-wheel/lib/umd/)
```html
<script src="https://cdn.jsdelivr.net/npm/@livelybone/mouse-wheel/lib/umd/<--module-->.js"></script>
```

---
_Source: https://npm.io/package/@livelybone/mouse-wheel · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._