1---
2category: Browser
3---
4 
5# useVibrate
6 
7Reactive [Vibration API](https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API)
8 
9Most modern mobile devices include vibration hardware, which lets software
10code provides physical feedback to the user by causing the device to shake.
11 
12The Vibration API offers Web apps the ability to access this hardware,
13if it exists, and does nothing if the device doesn't support it.
14 
15## Usage
16 
17Vibration is described as a pattern of on-off pulses, which may be of varying
18lengths.
19 
20The pattern may consist of either a single integer describing the
21number of milliseconds to vibrate, or an array of integers describing
22a pattern of vibrations and pauses.
23 
24```ts
25import { useVibrate } from '@vueuse/core'
26 
27// This vibrates the device for 300 ms
28// then pauses for 100 ms before vibrating the device again for another 300 ms:
29const { vibrate, stop, isSupported } = useVibrate({ pattern: [300, 100, 300] })
30 
31// Start the vibration, it will automatically stop when the pattern is complete:
32vibrate()
33 
34// But if you want to stop it, you can:
35stop()
36```
37 
38## Type Declarations
39 
40```ts
41export interface UseVibrateOptions
42  extends ConfigurableNavigator, ConfigurableScheduler {
43  /**
44   *
45   * Vibration Pattern
46   *
47   * An array of values describes alternating periods in which the
48   * device is vibrating and not vibrating. Each value in the array
49   * is converted to an integer, then interpreted alternately as
50   * the number of milliseconds the device should vibrate and the
51   * number of milliseconds it should not be vibrating
52   *
53   * @default []
54   *
55   */
56  pattern?: MaybeRefOrGetter<Arrayable<number>>
57  /**
58   * Interval to run a persistent vibration, in ms
59   *
60   * Pass `0` to disable
61   *
62   * @deprecated Please use `scheduler` option instead
63   * @default 0
64   *
65   */
66  interval: number
67}
68export interface UseVibrateReturn extends Supportable {
69  pattern: MaybeRefOrGetter<Arrayable<number>>
70  intervalControls?: Pausable
71  vibrate: (pattern?: Arrayable<number>) => void
72  stop: () => void
73}
74/**
75 * Reactive vibrate
76 *
77 * @see https://vueuse.org/useVibrate
78 * @see https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API
79 * @param options
80 *
81 * @__NO_SIDE_EFFECTS__
82 */
83export declare function useVibrate(
84  options?: UseVibrateOptions,
85): UseVibrateReturn
86```
87