Apache Cordova Vibration Plugin https://cordova.apache.org/
  • JavaScript 42.5%
  • C++ 36.5%
  • C# 9.8%
  • Java 8.6%
  • Objective-C 2.6%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2024-08-23 03:19:52 +03:00
.github CB-11917 - Remove pull request template checklist item: "iCLA has been submitted…" 2016-10-04 21:33:22 -07:00
doc CB-9128 cordova-plugin-vibration documentation translation: cordova-plugin-vibration 2015-06-12 09:42:50 -05:00
src Android SDK 26+ support 2024-08-23 03:19:52 +03:00
tests CB-12736 Updated version and RELEASENOTES.md for release 2.1.5 (via coho) 2017-04-27 13:12:44 -07:00
types CB-12369: Add plugin typings from DefinitelyTyped 2017-01-20 11:47:34 +03:00
www CB-12695: fix jshint / double-varing 2017-04-24 16:57:07 -07:00
.gitignore CB-10636 Add JSHint for plugins 2016-03-01 11:45:30 +03:00
.jshintrc CB-10636 Add JSHint for plugins 2016-03-01 11:45:30 +03:00
.ratignore Adding .ratignore file. 2015-06-16 21:30:59 -07:00
.travis.yml CB-10636 Add JSHint for plugins 2016-03-01 11:45:30 +03:00
CONTRIBUTING.md Actually fixing the contribute link. 2015-10-23 12:11:50 -07:00
LICENSE [license] adding apache license file 2013-08-06 14:42:09 -07:00
NOTICE updated notice file 2014-06-05 12:50:42 -07:00
package.json CB-12736 Updated version and RELEASENOTES.md for release 2.1.5 (via coho) 2017-04-27 13:12:44 -07:00
plugin.xml CB-12736 Updated version and RELEASENOTES.md for release 2.1.5 (via coho) 2017-04-27 13:12:44 -07:00
README.md CB-12622 Added Android 6.0 build badge to README 2017-04-26 16:37:00 +03:00
RELEASENOTES.md CB-12736 Updated version and RELEASENOTES.md for release 2.1.5 (via coho) 2017-04-27 13:12:44 -07:00

title description
Vibration Vibrate the device.
Android 4.4 Android 5.1 Android 6.0 iOS 9.3 iOS 10.0 Windows 10 Store Travis CI
Build Status Build Status Build Status Build Status Build Status Build Status Build Status

cordova-plugin-vibration

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() {
    console.log(navigator.vibrate);
}

⚠️ Report issues on the Apache Cordova issue tracker

Installation

cordova plugin add cordova-plugin-vibration

Supported Platforms

navigator.vibrate,
navigator.notification.vibrate

  • Amazon Fire OS
  • Android
  • BlackBerry 10
  • Firefox OS
  • iOS
  • Windows Phone 7 and 8
  • Windows (Windows Phone 8.1 devices only)

navigator.notification.vibrateWithPattern
navigator.notification.cancelVibration

  • Android
  • Windows Phone 8
  • Windows (Windows Phone 8.1 devices only)

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

Standard vibrate

Vibrates the device for a given amount of time.

navigator.vibrate(time)

or

navigator.vibrate([time])

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

Example

// Vibrate for 3 seconds
navigator.vibrate(3000);

// Vibrate for 3 seconds
navigator.vibrate([3000]);

iOS Quirks

  • time: Ignores the specified time and vibrates for a pre-set amount of time.

    navigator.vibrate(3000); // 3000 is ignored

Windows and Blackberry 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

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

Example

// 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]);

Windows Phone 8 Quirks

  • vibrate(pattern) falls back on vibrate with default duration

Cancel vibration (not supported in iOS)

Immediately cancels any currently running vibration.

navigator.vibrate(0)

or

navigator.vibrate([])

or

navigator.vibrate([0])

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

*notification.vibrate (deprecated)

Vibrates the device for a given amount of time.

navigator.notification.vibrate(time)
  • time: Milliseconds to vibrate the device. (Number)

Example

// Vibrate for 2.5 seconds
navigator.notification.vibrate(2500);

iOS Quirks

  • time: Ignores the specified time and vibrates for a pre-set amount of time.

      navigator.notification.vibrate();
      navigator.notification.vibrate(2500);   // 2500 is ignored
    

*notification.vibrateWithPattern (deprecated)

Vibrates the device with a given pattern.

navigator.notification.vibrateWithPattern(pattern, repeat)
  • pattern: Sequence of durations (in milliseconds) for which to turn on or off the vibrator. (Array of Numbers)
  • repeat: Optional index into the pattern array at which to start repeating (will repeat until canceled), or -1 for no repetition (default). (Number)

Example

// Immediately start vibrating
// vibrate for 100ms,
// wait for 100ms,
// vibrate for 200ms,
// wait for 100ms,
// vibrate for 400ms,
// wait for 100ms,
// vibrate for 800ms,
// (do not repeat)
navigator.notification.vibrateWithPattern([0, 100, 100, 200, 100, 400, 100, 800]);

*notification.cancelVibration (deprecated)

Immediately cancels any currently running vibration.

navigator.notification.cancelVibration()

*Note - due to alignment with w3c spec, the starred methods will be phased out