You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
mmmwhy 43f468ad0a no message 10 years ago
..
.gitignore no message 10 years ago
LICENSE.md no message 10 years ago
README.md no message 10 years ago
bower.json no message 10 years ago
index.html no message 10 years ago
package.json no message 10 years ago
shake.js no message 10 years ago

README.md

shake.js

A custom 'shake' event JavaScript plugin for mobile web browsers using device accelerometer.

Installation

  • Download: zip
  • NPM: npm install shake.js
  • Bower: bower install shake.js
  • Git: git clone https://github.com/alexgibson/shake.js

Dependencies

Your web browser must support the devicemotion event for this plugin to work. Shake.js uses built-in feature detection to determine if it can run in your web browser. It will terminate silently on non-supporting browsers.

http://w3c.github.io/deviceorientation/spec-source-orientation.html

Setup

For CommonJS using NPM:

var Shake = require('shake.js');

For AMD module:

define(['./shake'], function(Shake) {
    // ...
});

In the browser:

<script src="shake.js"></script>

Next, create a new Shake instance:

var myShakeEvent = new Shake({
    threshold: 15, // optional shake strength threshold
    timeout: 1000 // optional, determines the frequency of event generation
});

Start listening to device motion:

myShakeEvent.start();

Register a shake event listener on window with your callback:

window.addEventListener('shake', shakeEventDidOccur, false);

//function to call when shake occurs
function shakeEventDidOccur () {

    //put your own code here etc.
    alert('shake!');
}

You can stop listening for shake events like so:

window.removeEventListener('shake', shakeEventDidOccur, false);

To stop listening to device motion, you can call:

myShakeEvent.stop();

Supported web browsers/devices

  • iOS Safari 4.2.1 (and above)
  • Android 4.0.3 (default browser)
  • Chrome 41+ for Android
  • Opera Mobile (Android)
  • BlackBerry PlayBook 2.0
  • Firefox for Android
  • FirefoxOS Devices