Files
react-native/docs/0.55/vibration.html
T
Website Deployment Script 96523192bf Deploy website
Deploy website version based on cb71eb101ee1cc4c4f4b6a2edae9920740ccdd6b
2020-07-23 15:01:19 +00:00

146 lines
32 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Vibration · React Native</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="The Vibration API is exposed at `Vibration.vibrate()`. The vibration is synchronous so this method will return immediately."/><meta name="docsearch:version" content="0.55"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Vibration · React Native"/><meta property="og:type" content="website"/><meta property="og:url" content="https://reactnative.dev/"/><meta property="og:description" content="The Vibration API is exposed at `Vibration.vibrate()`. The vibration is synchronous so this method will return immediately."/><meta property="og:image" content="https://reactnative.dev/img/logo-og.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://reactnative.dev/img/logo-og.png"/><link rel="shortcut icon" href="/img/favicon.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/solarized-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://reactnative.dev/blog/atom.xml" title="React Native Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://reactnative.dev/blog/feed.xml" title="React Native Blog RSS Feed"/><script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-41298772-2', 'auto');
ga('send', 'pageview');
</script><script type="text/javascript" src="https://cdn.jsdelivr.net/npm/focus-visible@5.0.2/dist/focus-visible.min.js"></script><script type="text/javascript" src="https://snack.expo.io/embed.js"></script><script type="text/javascript" src="https://platform.twitter.com/widgets.js"></script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="/js/codeblocks.js"></script><script type="text/javascript" src="/js/tabs.js"></script><script type="text/javascript" src="/js/docs-rating.js"></script><script type="text/javascript" src="/js/announcement.js"></script><script type="text/javascript" src="/js/survey-banner.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
document.addEventListener('DOMContentLoaded', function() {
addBackToTop(
{"zIndex":100}
)
});
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/prism.css"/><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/header_logo.svg" alt="React Native"/><h2 class="headerTitleWithLogo">React Native</h2></a><a href="/versions"><h3>0.55</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/0.55/getting-started" target="_self">Docs</a></li><li class="siteNavGroupActive"><a href="/docs/0.55/components-and-apis" target="_self">Components</a></li><li class="siteNavGroupActive"><a href="/docs/0.55/accessibilityinfo" target="_self">API</a></li><li class=""><a href="/help" target="_self">Community</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li><li class="navSearchWrapper reactNavSearchWrapper"><input type="text" id="search_input_react" placeholder="Search" title="Search"/></li><li class=""><a href="https://github.com/facebook/react-native" target="_self">GitHub</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><div class="hamburger-menu"><div class="line1"></div><div class="line2"></div><div class="line3"></div></div></div><h2><i></i><span>APIs</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">The Basics<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/0.55/getting-started">Getting Started</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/tutorial">Learn the Basics</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/props">Props</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/state">State</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/style">Style</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/height-and-width">Height and Width</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/flexbox">Layout with Flexbox</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/handling-text-input">Handling Text Input</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/handling-touches">Handling Touches</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/using-a-scrollview">Using a ScrollView</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/using-a-listview">Using List Views</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/network">Networking</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/more-resources">More Resources</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Guides<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/0.55/components-and-apis">Components and APIs</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/platform-specific-code">Platform Specific Code</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/navigation">Navigating Between Screens</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/images">Images</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/animations">Animations</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/accessibility">Accessibility</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/improvingux">Improving User Experience</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/timers">Timers</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/debugging">Debugging</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/performance">Performance</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/gesture-responder-system">Gesture Responder System</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/javascript-environment">JavaScript Environment</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/direct-manipulation">Direct Manipulation</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/colors">Color Reference</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/integration-with-existing-apps">Integration with Existing Apps</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/building-for-tv">Building For TV Devices</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/running-on-device">Running On Device</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/upgrading">Upgrading to new React Native versions</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/troubleshooting">Troubleshooting</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/native-modules-setup">Native Modules Setup</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Guides (iOS)<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/0.55/native-modules-ios">Native Modules</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/native-components-ios">Native UI Components</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/linking-libraries-ios">Linking Libraries</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/running-on-simulator-ios">Running On Simulator</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/communication-ios">Communication between native and React Native</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/app-extensions">App Extensions</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Guides (Android)<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/0.55/native-modules-android">Native Modules</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/native-components-android">Native UI Components</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/headless-js-android">Headless JS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/signed-apk-android">Publishing to Google Play Store</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/removing-default-permissions">Removing Default Permissions</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Components<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/0.55/activityindicator">ActivityIndicator</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/button">Button</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/datepickerios">DatePickerIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/drawerlayoutandroid">DrawerLayoutAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/flatlist">FlatList</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/image">Image</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/imagebackground">ImageBackground</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/inputaccessoryview">InputAccessoryView</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/keyboardavoidingview">KeyboardAvoidingView</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/listview">ListView</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/maskedviewios">MaskedViewIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/modal">Modal</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/navigatorios">NavigatorIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/picker">Picker</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/pickerios">PickerIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/progressbarandroid">ProgressBarAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/progressviewios">ProgressViewIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/refreshcontrol">RefreshControl</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/safeareaview">SafeAreaView</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/scrollview">ScrollView</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/sectionlist">SectionList</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/segmentedcontrolios">SegmentedControlIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/slider">Slider</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/snapshotviewios">SnapshotViewIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/statusbar">StatusBar</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/switch">Switch</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/tabbarios">TabBarIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/tabbarios-item">TabBarIOS.Item</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/text">Text</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/textinput">TextInput</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/toolbarandroid">ToolbarAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/touchablehighlight">TouchableHighlight</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/touchablenativefeedback">TouchableNativeFeedback</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/touchableopacity">TouchableOpacity</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/touchablewithoutfeedback">TouchableWithoutFeedback</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/view">View</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/viewpagerandroid">ViewPagerAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/virtualizedlist">VirtualizedList</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/webview">WebView</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">APIs<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/0.55/accessibilityinfo">AccessibilityInfo</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/actionsheetios">ActionSheetIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/alert">Alert</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/alertios">AlertIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/animated">Animated</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/appregistry">AppRegistry</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/appstate">AppState</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/asyncstorage">AsyncStorage</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/backandroid">BackAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/backhandler">BackHandler</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/cameraroll">CameraRoll</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/clipboard">Clipboard</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/datepickerandroid">DatePickerAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/dimensions">Dimensions</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/easing">Easing</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/geolocation">Geolocation</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/imageeditor">ImageEditor</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/imagepickerios">ImagePickerIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/imagestore">ImageStore</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/image-style-props">Image Style Props</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/interactionmanager">InteractionManager</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/keyboard">Keyboard</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/layout-props">Layout Props</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/layoutanimation">LayoutAnimation</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/linking">Linking</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/listviewdatasource">ListViewDataSource</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/netinfo">NetInfo</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/panresponder">PanResponder</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/permissionsandroid">PermissionsAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/pixelratio">PixelRatio</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/pushnotificationios">PushNotificationIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/settings">Settings</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/shadow-props">Shadow Props</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/share">Share</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/statusbarios">StatusBarIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/stylesheet">StyleSheet</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/systrace">Systrace</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/text-style-props">Text Style Props</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/timepickerandroid">TimePickerAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/toastandroid">ToastAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/transforms">Transforms</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/docs/0.55/vibration">Vibration</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/vibrationios">VibrationIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.55/view-style-props">View Style Props</a></li></ul></div></div></section></div><script>
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
var links = coll[i].nextElementSibling.getElementsByTagName('*');
if (checkActiveCategory){
for (var j = 0; j < links.length; j++) {
if (links[j].classList.contains('navListItemActive')){
coll[i].nextElementSibling.classList.toggle('hide');
coll[i].childNodes[1].classList.toggle('rotate');
checkActiveCategory = false;
break;
}
}
}
coll[i].addEventListener('click', function() {
var arrow = this.childNodes[1];
arrow.classList.toggle('rotate');
var content = this.nextElementSibling;
content.classList.toggle('hide');
});
}
document.addEventListener('DOMContentLoaded', function() {
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
createToggler('#tocToggler', 'body', 'tocActive');
var headings = document.querySelector('.toc-headings');
headings && headings.addEventListener('click', function(event) {
var el = event.target;
while(el !== headings){
if (el.tagName === 'A') {
document.body.classList.remove('tocActive');
break;
} else{
el = el.parentNode;
}
}
}, false);
function createToggler(togglerSelector, targetSelector, className) {
var toggler = document.querySelector(togglerSelector);
var target = document.querySelector(targetSelector);
if (!toggler) {
return;
}
toggler.onclick = function(event) {
event.preventDefault();
target.classList.toggle(className);
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/facebook/react-native-website/blob/master/docs/vibration.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">Vibration</h1></header><article><div><span><p>The Vibration API is exposed at <code>Vibration.vibrate()</code>. The vibration is synchronous so this method will return immediately.</p>
<p>There will be no effect on devices that do not support Vibration, eg. the simulator.</p>
<p><strong>Note for Android:</strong> add <code>&lt;uses-permission android:name=&quot;android.permission.VIBRATE&quot;/&gt;</code> to <code>AndroidManifest.xml</code></p>
<p>Since the <strong>vibration duration in iOS is not configurable</strong>, so there are some differences with Android. In Android, if <code>pattern</code> is a number, it specifies the vibration duration in ms. If <code>pattern</code> is an array, those odd indices are the vibration duration, while the even ones are the separation time.</p>
<p>In iOS, invoking <code>vibrate(duration)</code> will ignore the duration and vibrate for a fixed time. While the <code>pattern</code> array is used to define the duration between each vibration. See below example for more.</p>
<p>Repeatable vibration is also supported, the vibration will repeat with defined pattern until <code>cancel()</code> is called.</p>
<p>Example:</p>
<pre><code class="hljs">const DURATION = <span class="hljs-number">10000</span>
const PATTERN = [<span class="hljs-number">1000</span>, <span class="hljs-number">2000</span>, <span class="hljs-number">3000</span>]
Vibration.vibrate(DURATION)
// Android: vibrate <span class="hljs-keyword">for</span> <span class="hljs-number">10</span>s
// iOS: duration is not configurable, vibrate <span class="hljs-keyword">for</span> fixed <span class="hljs-built_in">time</span> (about <span class="hljs-number">500</span>ms)
Vibration.vibrate(PATTERN)
// Android: wait <span class="hljs-number">1</span>s -&gt; vibrate <span class="hljs-number">2</span>s -&gt; wait <span class="hljs-number">3</span>s
// iOS: wait <span class="hljs-number">1</span>s -&gt; vibrate -&gt; wait <span class="hljs-number">2</span>s -&gt; vibrate -&gt; wait <span class="hljs-number">3</span>s -&gt; vibrate
Vibration.vibrate(PATTERN, true)
// Android: wait <span class="hljs-number">1</span>s -&gt; vibrate <span class="hljs-number">2</span>s -&gt; wait <span class="hljs-number">3</span>s -&gt; wait <span class="hljs-number">1</span>s -&gt; vibrate <span class="hljs-number">2</span>s -&gt; wait <span class="hljs-number">3</span>s -&gt; ...
// iOS: wait <span class="hljs-number">1</span>s -&gt; vibrate -&gt; wait <span class="hljs-number">2</span>s -&gt; vibrate -&gt; wait <span class="hljs-number">3</span>s -&gt; vibrate -&gt; wait <span class="hljs-number">1</span>s -&gt; vibrate -&gt; wait <span class="hljs-number">2</span>s -&gt; vibrate -&gt; wait <span class="hljs-number">3</span>s -&gt; vibrate -&gt; ...
Vibration.cancel()
// Android: vibration stopped
// iOS: vibration stopped
</code></pre>
<h3><a class="anchor" aria-hidden="true" id="methods"></a><a href="#methods" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Methods</h3>
<ul>
<li><a href="/docs/0.55/vibration#vibrate"><code>vibrate</code></a></li>
<li><a href="/docs/0.55/vibration#cancel"><code>cancel</code></a></li>
</ul>
<hr>
<h1><a class="anchor" aria-hidden="true" id="reference"></a><a href="#reference" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Reference</h1>
<h2><a class="anchor" aria-hidden="true" id="methods-1"></a><a href="#methods-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Methods</h2>
<h3><a class="anchor" aria-hidden="true" id="vibrate"></a><a href="#vibrate" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>vibrate()</code></h3>
<pre><code class="hljs css language-jsx">Vibration<span class="token punctuation">.</span><span class="token function">vibrate</span><span class="token punctuation">(</span>pattern<span class="token punctuation">:</span> number<span class="token punctuation">,</span> Array<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>number</span><span class="token punctuation">></span></span><span class="token plain-text">, repeat: boolean)
</span></code></pre>
<p>Trigger a vibration with specified <code>pattern</code>.</p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr>
</thead>
<tbody>
<tr><td>pattern</td><td>number or Array<number></td><td>Yes</td><td>Vibration pattern, accept a number or an array of numbers. Default to 400ms.</td></tr>
<tr><td>repeat</td><td>boolean</td><td>No</td><td>Repeat vibration pattern until cancel(), default to false.</td></tr>
</tbody>
</table>
<hr>
<h3><a class="anchor" aria-hidden="true" id="cancel"></a><a href="#cancel" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>cancel()</code></h3>
<pre><code class="hljs css language-jsx">Vibration<span class="token punctuation">.</span><span class="token function">cancel</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre>
<p>Stop vibration.</p>
<pre><code class="hljs"><span class="hljs-module-access"><span class="hljs-module"><span class="hljs-identifier">Vibration</span>.</span></span>cancel<span class="hljs-literal">()</span>
</code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/0.55/transforms"><span class="arrow-prev"></span><span>Transforms</span></a><a class="docs-next button" href="/docs/0.55/vibrationios"><span>Next</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#methods-1">Methods</a><ul class="toc-headings"><li><a href="#vibrate"><code>vibrate()</code></a></li><li><a href="#cancel"><code>cancel()</code></a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><div><h5>Docs</h5><a href="/docs/getting-started">Getting Started</a><a href="/docs/tutorial">Tutorial</a><a href="/docs/components-and-apis">Components and APIs</a><a href="/docs/more-resources">More Resources</a></div><div><h5>Community</h5><a href="/help">The React Native Community</a><a href="/showcase">Who&#x27;s using React Native?</a><a href="https://stackoverflow.com/questions/tagged/react-native" target="_blank">Ask Questions on Stack Overflow</a><a href="https://github.com/facebook/react-native/blob/master/CONTRIBUTING.md">Contributor Guide</a><a href="https://dev.to/t/reactnative" target="_blank">DEV Community</a></div><div><h5>More Resources</h5><a href="/blog">Blog</a><a href="https://twitter.com/reactnative" target="_blank">Twitter</a><a href="https://github.com/facebook/react-native" target="_blank">GitHub</a><a href="https://reactjs.org" target="_blank">React</a></div></section><a href="https://code.facebook.com/projects/" target="_blank" class="fbOpenSource"><img src="/img/oss_logo.png" alt="Facebook Open Source" width="170" height="45"/></a><section class="copyright">Copyright © 2020 Facebook Inc.</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>window.fbAsyncInit = function() {FB.init({appId:'1677033832619985',xfbml:true,version:'v2.7'});};(function(d, s, id){var js, fjs = d.getElementsByTagName(s)[0];if (d.getElementById(id)) {return;}js = d.createElement(s); js.id = id;js.src = '//connect.facebook.net/en_US/sdk.js';fjs.parentNode.insertBefore(js, fjs);}(document, 'script','facebook-jssdk'));
</script><script>window.twttr=(function(d,s, id){var js,fjs=d.getElementsByTagName(s)[0],t=window.twttr||{};if(d.getElementById(id))return t;js=d.createElement(s);js.id=id;js.src='https://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js, fjs);t._e = [];t.ready = function(f) {t._e.push(f);};return t;}(document, 'script', 'twitter-wjs'));</script><script>
document.addEventListener('keyup', function(e) {
if (e.target !== document.body) {
return;
}
// keyCode for '/' (slash)
if (e.keyCode === 191) {
const search = document.getElementById('search_input_react');
search && search.focus();
}
});
</script><script>
var search = docsearch({
apiKey: '2c98749b4a1e588efec53b2acec13025',
indexName: 'react-native-versions',
inputSelector: '#search_input_react',
algoliaOptions: {"facetFilters":["tags:0.55"],"hitsPerPage":5}
});
</script></body></html>