Apache Cordova Plugin vibration

Clone this repo:
  1. 1276623 ci(appveyor): add node 12, remove node 6 by Jan Piotrowski · 7 months ago master
  2. f493fbf fix(types): remove version number by Jan Piotrowski · 7 months ago
  3. 48742c1 ci(travis): upgrade to node 8 by Jan Piotrowski · 7 months ago
  4. 1e0f4e0 ci(travis): Remove Android 4.4, Add Android 9.0 by Jan Piotrowski · 7 months ago
  5. 2438539 Merge pull request #76 from timbru31/feat/drop-node-v4 by Tim Brust · 9 months ago

title: Vibration description: Vibrate the device.

|AppVeyor|Travis CI| |:-:|:-:| |Build status|Build Status|


This plugin aligns with the W3C vibration specification http://www.w3.org/TR/vibration/

This plugin provides a way to vibrate the device.

This plugin defines global objects including navigator.vibrate.

Although in the global scope, they are not available until after the deviceready event.

document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {


cordova plugin add cordova-plugin-vibration

Supported Platforms


  • Android
  • iOS
  • Windows

The Android webview (API level 19 and up) supports the W3C Vibration API natively and therefore, the Android specific implementation of this plugin has been dropped.


This function has three different functionalities based on parameters passed to it.

Standard vibrate

Vibrates the device for a given amount of time.




-time: Milliseconds to vibrate the device. (Number)


// Vibrate for 3 seconds

// Vibrate for 3 seconds

Android Quirks

Calls to navigator.vibrate will immediately return false if user hasn't tapped on the frame or any embedded frame yet. Please checkout https://issues.apache.org/jira/browse/CB-14022 for more information.

iOS Quirks

  • time: Ignores the specified time and vibrates for a pre-set amount of time.
navigator.vibrate(3000); // 3000 is ignored

Windows Quirks

  • time: Max time is 5000ms (5s) and min time is 1ms
navigator.vibrate(8000); // will be truncated to 5000

Vibrate with a pattern (Android and Windows only)

Vibrates the device with a given pattern

  • pattern: Sequence of durations (in milliseconds) for which to turn on or off the vibrator. (Array of Numbers)


// Vibrate for 1 second
// Wait for 1 second
// Vibrate for 3 seconds
// Wait for 1 second
// Vibrate for 5 seconds
navigator.vibrate([1000, 1000, 3000, 1000, 5000]);

Cancel vibration (not supported in iOS)

Immediately cancels any currently running vibration.






Passing in a parameter of 0, an empty array, or an array with one element of value 0 will cancel any vibrations.