Vibration Plugin
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);
}
cordova-plugin-vibration
- Android
- iOS
navigator.notification.vibrateWithPattern
& navigator.notification.cancelVibration
are not working on iOS platform.This function has three different functionalities based on parameters passed to it.
Vibrates the device for a given amount of time.
navigator.vibrate(time)
or
navigator.vibrate([time])
- time: Milliseconds to vibrate the device. (Number)
// Vibrate for 3 seconds
navigator.vibrate(3000);
// Vibrate for 3 seconds
navigator.vibrate([3000]);
- time: Ignores the specified time and vibrates for a pre-set amount of time.
javascriptnavigator.vibrate(3000); // 3000 is ignored
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)
// 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]);
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.
Vibrates the device for a given amount of time.
navigator.notification.vibrate(time)
- time: Milliseconds to vibrate the device. (Number)
// Vibrate for 2.5 seconds
navigator.notification.vibrate(2500);
- time: Ignores the specified time and vibrates for a pre-set amount of time.
navigator.notification.vibrate();
navigator.notification.vibrate(2500); // 2500 is ignored
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)
// 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]);
Immediately cancels any currently running vibration.
navigator.notification.cancelVibration()
Due to alignment with w3c spec, the starred methods will be phased out.
See Also:
Last modified 1yr ago