Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Usage
The event callback receives 3 extra arguments which are the normalized “deltas” of the mouse wheel.

```js
var hamster = Hamster(el);
var hamster = Hamster(el, false); // boolean is whether passive = true | false

hamster.wheel(function(event, delta, deltaX, deltaY){
console.log(delta, deltaX, deltaY);
Expand All @@ -24,13 +24,16 @@ hamster.unwheel();
Support
-------

No jQuery or other libraries required, but an <a href="http://github.com/monospaced/angular-mousewheel">adapter for AngularJS</a> is available.
The second parameter to Hamster() is optional, and indicates whether to mark the event listener as passive, for performance. Please do your research about passive event listeners before turning this on.

No jQuery or other libraries are required, but an <a href="http://github.com/monospaced/angular-mousewheel">adapter for AngularJS</a> is available.

Tested in these [core browsers](http://monospaced.github.io/obs).

Install
-------

npm install hamsterjs
bower install hamsterjs

Demo
Expand All @@ -43,3 +46,4 @@ Reference

* [jquery-mousewheel](https://github.com/brandonaaron/jquery-mousewheel)
* [wheel event on MDN](https://developer.mozilla.org/en-US/docs/DOM/Mozilla_event_reference/wheel)
* [Passive Event Listeners by Google](https://developers.google.com/web/updates/2016/06/passive-event-listeners)
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "hamsterjs",
"version": "1.1.2",
"version": "1.1.4",
"main": "hamster.js",
"ignore": [
"**/.*",
Expand Down
9 changes: 9 additions & 0 deletions hamster.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
// Type definitions for Hamster.js 1.1.4
// Definitions by: Kensington Technology associates <[~https://knowledgekta.com~]>

declare function Hamster(el: HTMLElement, passive?: boolean): Hamster;

interface Hamster {
wheel( handler, useCapture?: boolean );
unwheel();
}
Loading