@livelybone/mouse-wheel/README.md

A module for bind mouse-wheel event. typescript supported

# @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>
```