Vibrates the device.
- Function Component
- Class Component
Android apps should request the
android.permission.VIBRATEpermission by adding
The Vibration API is implemented as a
AudioServicesPlaySystemSound(kSystemSoundID_Vibrate)call on iOS.
Vibration.vibrate(?pattern: number | Array<number>, ?repeat: boolean)
Triggers a vibration with a fixed duration.
On Android, the vibration duration defaults to 400 milliseconds, and an arbitrary vibration duration can be specified by passing a number as the value for the
pattern argument. On iOS, the vibration duration is fixed at roughly 400 milliseconds.
vibrate() method can take a
pattern argument with an array of numbers that represent time in milliseconds. You may set
repeat to true to run through the vibration pattern in a loop until
cancel() is called.
On Android, the odd indices of the
pattern array represent the vibration duration, while the even ones represent the separation time. On iOS, the numbers in the
pattern array represent the separation time, as the vibration duration is fixed.
|pattern||number||No||Vibration duration in milliseconds. Defaults to 400 ms.||Android|
|pattern||Array of numbers||No||Vibration pattern as an array of numbers in milliseconds.||Android, iOS|
|repeat||boolean||No||Repeat vibration pattern until cancel(), default to false.||Android, iOS|
Call this to stop vibrating after having invoked
vibrate() with repetition enabled.