react-native/docs/vibrationios.md
Héctor Ramos e11d496e9d Additional markdown adjustments
Summary:
Follow up to 9ec95673909beac7798f589e0e9821b4225f8fa9
Closes https://github.com/facebook/react-native/pull/16759

Differential Revision: D6285219

Pulled By: hramos

fbshipit-source-id: 7012d257a5a6cff06cb2d94203a9379e4b7e3c4e
2017-11-09 09:55:05 -08:00

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.**