Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including cordova-plugin-vibration with all npm packages installed. Try it out:

cordova-plugin-vibration lists no main file and has no index.js, so it can't be directly required. If this is a mistake, please let us know. It may however contain internal files that you can require manually:

// require("cordova-plugin-vibration/[??]")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

cordova-plugin-vibration v3.1.1

Cordova Vibration Plugin

title: Vibration description: Vibrate the device.

AppVeyorTravis CI
Build statusBuild Status


This plugin aligns with the W3C vibration specification

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 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.


RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free