ShakeProgress aggregates Shake events based on a minimum number of shakes and minimum amount of time since shaking began. It returns a progress value that starts at 0 and increases as the device is shaken until progress reaches a value of 1. At this time, the shake gesture is considered complete. The API only fires when the progress is updated. ShakeProgress relies on the device's Accelerometer sensor.

When motion events are not available on the device, ShakeProgress events are polyfilled with swipe touch events.

Example

var shakeProgress = new MotionStack.ShakeProgress({
  minShakes: 10,
  minTime: 1000,
  direction: "all"
});

shakeProgress.start(function (e) {
  console.log(e.progress);

  if (e.progress == 1) {
    shakeProgress.stop();
  }
});

Constructor

new MotionStack.ShakeProgress([options])

Create a new ShakeProgress instance object.

var shakeProgress = new MotionStack.ShakeProgress({
  minShakes: 10,
  minTime: 1000
});

Instance Methods

start(callback, [context])

Start receiving shake progress updates.

shakeProgress.start(function(e) {
  console.log(e.progress);
});

stop()

Stop shakeProgress updates.

shakeProgress.stop();

Source

src/interfaces/ShakeProgress.js