react-native/docs/vibrationios.md

44 lines
741 B
Markdown

---
id: vibrationios
title: VibrationIOS
layout: docs
category: APIs
permalink: docs/vibrationios.html
next: layout-props
previous: vibration
---
> NOTE:
> `VibrationIOS` is deprecated. Use [`Vibration`](docs/vibration.html) instead.
The Vibration API is exposed at `VibrationIOS.vibrate()`. On iOS, calling this function will trigger a one second vibration. The vibration is asynchronous so this method will return immediately.
There will be no effect on devices that do not support Vibration, eg. the iOS simulator.
Vibration patterns are currently unsupported.
### Methods
- [`vibrate`](docs/vibrationios.html#vibrate)
---
# Reference
## Methods
### `vibrate()`
```javascript
VibrationIOS.vibrate()
```
**Deprecated.**