# @awesome-cordova-library/vibration

> This plugin provides a way to vibrate the device. Its API aligns with the W3C vibration specification at http://www.w3.org/TR/vibration/

Latest version **1.0.2** (published 2023-09-12) · SEE LICENSE IN LICENSE license · 0 weekly downloads

## Install

```sh
npm install @awesome-cordova-library/vibration
pnpm add @awesome-cordova-library/vibration
yarn add @awesome-cordova-library/vibration
bun add @awesome-cordova-library/vibration
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2023-09-12 |
| First published | 2022-05-31 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN LICENSE |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Jordan AZOULAY |
| Maintainers | joazco |
| Keywords | cordova, capacitor, ionic, javascript, mobile, vibration |

## Links

- npm: https://www.npmjs.com/package/@awesome-cordova-library/vibration
- Repository: https://github.com/joazco/awesome-cordova-library
- Issues: https://github.com/joazco/awesome-cordova-library/issues
- npm.io page: https://npm.io/package/@awesome-cordova-library/vibration

## Recent versions

- 1.0.2 (latest) — 2023-09-12
- 1.0.1 — 2022-05-31
- 1.0.0 — 2022-05-31

## README

---
id: plugin-vibration
title: Vibration
tags:
  - cordova
  - capacitor
  - ionic
  - javascript
  - typescript
  - plugin
  - mobile
  - vibration
---

# Vibration

This plugin provides a way to vibrate the device. Its API aligns with the W3C vibration specification at

[Online documentation](https://awesomecordovalibrary.com)

[Cordova documentation](https://cordova.apache.org/docs/en/11.x/reference/cordova-plugin-vibration/index.html)

[W3C documentation](http://www.w3.org/TR/vibration/)

## Installation

### Cordova

```sh
cordova plugin add cordova-plugin-vibration
npm install @awesome-cordova-library/vibration
```

### Capacitor / Ionic

```bash
npm install cordova-plugin-vibration
npm install @awesome-cordova-library/vibration
npx cap sync
```

## Vanilla

### Declaration

```typescript
class Vibration {
  static vibrate(time: number | number[]): void;
}
```

### Usages

```typescript
import Vibration from "@awesome-cordova-library/vibration";

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

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

## React

### Declaration

```typescript
const useVibration: () => (time: number | number[]) => void;
```

### Usages

```typescript
import { useEffect } from "react";
import useVibration from "@awesome-cordova-library/vibration/lib/react";

function App() {
  const vibrate = useVibration();

  useEffect(() => {
    // Vibrate for 1 second
    // Wait for 1 second
    // Vibrate for 3 seconds
    // Wait for 1 second
    // Vibrate for 5 seconds
    vibrate([1000, 1000, 3000, 1000, 5000]);
  }, []);

  return <div />;
}
```

## Quirks

Mulitple vibration not supported on iOS

---
_Source: https://npm.io/package/@awesome-cordova-library/vibration · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._