@livelybone/mouse-wheel

A module for bind mouse-wheel event. typescript supported

Stats

StarsIssuesVersionUpdatedCreatedSize
@livelybone/mouse-wheel
104.2.1a year ago3 years agoMinified + gzip package size for @livelybone/mouse-wheel in KB

Readme

@livelybone/mouse-wheel

NPM Version Download Month gzip with dependencies: kb typescript pkg.module

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

中文文档

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

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

Usage

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

<-- 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

<script src="https://cdn.jsdelivr.net/npm/@livelybone/mouse-wheel/lib/umd/<--module-->.js"></script>

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.