← Plugins  /  Vibration

iOS Android

This Apache Cordova plugin lets your app deliver haptic feedback — a single buzz or a custom rhythm of buzzes. It's a simple way to confirm an action, flag an alert, or add tactile punch to a game.

Installation

Add the plugin to your Cordova project from the command line:

cordova plugin add cordova-plugin-vibration

Methods

The plugin extends the global navigator object with a vibrate function. Call it after deviceready has fired:

Platform note

On iOS the duration and any pattern are disregarded — the device always plays its single, standard short vibration. Custom patterns and cancellation are available on Android only.

Usage example

Fire a quick confirmation buzz, or play a short two-part pattern:

document.addEventListener("deviceready", onReady, false);

function onReady() {
  // A quick confirmation buzz
  navigator.vibrate(200);

  // An Android pattern: wait 0ms, buzz 200ms, wait 100ms, buzz 200ms
  navigator.vibrate([0, 200, 100, 200]);
}

Tips

• Call navigator.vibrate after deviceready — it isn't available before then.
• Use vibration sparingly and only for feedback that means something — constant buzzing quickly annoys users.
• Remember that iOS ignores custom durations and patterns, so design your feedback to work with a single short buzz too.
• Some devices and users disable vibration in their system settings, so never rely on it as the only signal.