forked from facebook/react-native
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
198 lines (185 loc) · 35.3 KB
/
index.html
File metadata and controls
198 lines (185 loc) · 35.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>PanResponder · React Native</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="`PanResponder` reconciles several touches into a single gesture. It makes single-touch gestures resilient to extra touches, and can be used to recognize basic multi-touch gestures."/><meta name="docsearch:version" content="0.34"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="PanResponder · React Native"/><meta property="og:type" content="website"/><meta property="og:url" content="https://reactnative.dev/"/><meta property="og:description" content="`PanResponder` reconciles several touches into a single gesture. It makes single-touch gestures resilient to extra touches, and can be used to recognize basic multi-touch gestures."/><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 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.34</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/0.34/getting-started" target="_self">Docs</a></li><li class="siteNavGroupActive"><a href="/docs/0.34/components-and-apis" target="_self">Components</a></li><li class=""><a href="/docs/0.34/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.34/getting-started">Getting Started</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/tutorial">Learn the Basics</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/props">Props</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/state">State</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/style">Style</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/height-and-width">Height and Width</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/flexbox">Layout with Flexbox</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/handling-text-input">Handling Text Input</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/handling-touches">Handling Touches</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/using-a-scrollview">Using a ScrollView</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/using-a-listview">Using List Views</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/network">Networking</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/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.34/components-and-apis">Components and APIs</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/platform-specific-code">Platform Specific Code</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/navigation">Navigating Between Screens</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/images">Images</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/animations">Animations</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/accessibility">Accessibility</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/improvingux">Improving User Experience</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/timers">Timers</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/debugging">Debugging</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/performance">Performance</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/gesture-responder-system">Gesture Responder System</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/javascript-environment">JavaScript Environment</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/direct-manipulation">Direct Manipulation</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/colors">Color Reference</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/integration-with-existing-apps">Integration with Existing Apps</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/running-on-device">Running On Device</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/upgrading">Upgrading to new React Native versions</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/troubleshooting">Troubleshooting</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/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.34/native-modules-ios">Native Modules</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/native-components-ios">Native UI Components</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/linking-libraries-ios">Linking Libraries</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/running-on-simulator-ios">Running On Simulator</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/communication-ios">Communication between native and React Native</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/building-for-tv">Building For TV Devices</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/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.34/native-modules-android">Native Modules</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/native-components-android">Native UI Components</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/headless-js-android">Headless JS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/signed-apk-android">Publishing to Google Play Store</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/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.34/activityindicator">ActivityIndicator</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/datepickerios">DatePickerIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/drawerlayoutandroid">DrawerLayoutAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/image">Image</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/keyboardavoidingview">KeyboardAvoidingView</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/modal">Modal</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/navigator">Navigator</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/navigatorios">NavigatorIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/picker">Picker</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/pickerios">PickerIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/progressbarandroid">ProgressBarAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/progressviewios">ProgressViewIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/refreshcontrol">RefreshControl</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/scrollview">ScrollView</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/segmentedcontrolios">SegmentedControlIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/slider">Slider</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/snapshotviewios">SnapshotViewIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/statusbar">StatusBar</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/switch">Switch</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/tabbarios">TabBarIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/tabbarios-item">TabBarIOS.Item</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/text">Text</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/textinput">TextInput</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/toolbarandroid">ToolbarAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/touchablehighlight">TouchableHighlight</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/touchablenativefeedback">TouchableNativeFeedback</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/touchableopacity">TouchableOpacity</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/touchablewithoutfeedback">TouchableWithoutFeedback</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/viewpagerandroid">ViewPagerAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/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.34/actionsheetios">ActionSheetIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/animated">Animated</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/appstate">AppState</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/asyncstorage">AsyncStorage</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/cameraroll">CameraRoll</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/clipboard">Clipboard</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/datepickerandroid">DatePickerAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/dimensions">Dimensions</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/easing">Easing</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/geolocation">Geolocation</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/imageeditor">ImageEditor</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/imagepickerios">ImagePickerIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/imagestore">ImageStore</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/image-style-props">Image Style Props</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/interactionmanager">InteractionManager</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/layout-props">Layout Props</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/layoutanimation">LayoutAnimation</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/linking">Linking</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/netinfo">NetInfo</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/docs/0.34/panresponder">PanResponder</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/permissionsandroid">PermissionsAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/pixelratio">PixelRatio</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/pushnotificationios">PushNotificationIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/settings">Settings</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/shadow-props">Shadow Props</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/share">Share</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/statusbarios">StatusBarIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/stylesheet">StyleSheet</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/text-style-props">Text Style Props</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/timepickerandroid">TimePickerAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/toastandroid">ToastAndroid</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/transforms">Transforms</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/vibration">Vibration</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/vibrationios">VibrationIOS</a></li><li class="navListItem"><a class="navItem" href="/docs/0.34/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/panresponder.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">PanResponder</h1></header><article><div><span><p><code>PanResponder</code> reconciles several touches into a single gesture. It makes single-touch gestures resilient to extra touches, and can be used to recognize basic multi-touch gestures.</p>
<p>By default, <code>PanResponder</code> holds an `InteractionManager handle to block long-running JS events from interrupting active gestures.</p>
<p>It provides a predictable wrapper of the responder handlers provided by the <a href="/docs/0.34/gesture-responder-system">gesture responder system</a>. For each handler, it provides a new <code>gestureState</code> object alongside the native event object:</p>
<pre><code class="hljs">onPanResponderMove: <span class="hljs-function"><span class="hljs-params">(event, gestureState)</span> =></span> {}
</code></pre>
<p>A native event is a synthetic touch event with the following form:</p>
<ul>
<li><code>nativeEvent</code>
<ul>
<li><code>changedTouches</code> - Array of all touch events that have changed since the last event</li>
<li><code>identifier</code> - The ID of the touch</li>
<li><code>locationX</code> - The X position of the touch, relative to the element</li>
<li><code>locationY</code> - The Y position of the touch, relative to the element</li>
<li><code>pageX</code> - The X position of the touch, relative to the root element</li>
<li><code>pageY</code> - The Y position of the touch, relative to the root element</li>
<li><code>target</code> - The node id of the element receiving the touch event</li>
<li><code>timestamp</code> - A time identifier for the touch, useful for velocity calculation</li>
<li><code>touches</code> - Array of all current touches on the screen</li>
</ul></li>
</ul>
<p>A <code>gestureState</code> object has the following:</p>
<ul>
<li><code>stateID</code> - ID of the gestureState- persisted as long as there at least one touch on screen</li>
<li><code>moveX</code> - the latest screen coordinates of the recently-moved touch</li>
<li><code>moveY</code> - the latest screen coordinates of the recently-moved touch</li>
<li><code>x0</code> - the screen coordinates of the responder grant</li>
<li><code>y0</code> - the screen coordinates of the responder grant</li>
<li><code>dx</code> - accumulated distance of the gesture since the touch started</li>
<li><code>dy</code> - accumulated distance of the gesture since the touch started</li>
<li><code>vx</code> - current velocity of the gesture</li>
<li><code>vy</code> - current velocity of the gesture</li>
<li><code>numberActiveTouches</code> - Number of touches currently on screen</li>
</ul>
<h3><a class="anchor" aria-hidden="true" id="basic-usage"></a><a href="#basic-usage" 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>Basic Usage</h3>
<pre><code class="hljs"> componentWillMount: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
<span class="hljs-keyword">this</span>._panResponder = PanResponder.create({
<span class="hljs-comment">// Ask to be the responder:</span>
<span class="hljs-attr">onStartShouldSetPanResponder</span>: <span class="hljs-function">(<span class="hljs-params">evt, gestureState</span>) =></span> <span class="hljs-literal">true</span>,
<span class="hljs-attr">onStartShouldSetPanResponderCapture</span>: <span class="hljs-function">(<span class="hljs-params">evt, gestureState</span>) =></span> <span class="hljs-literal">true</span>,
<span class="hljs-attr">onMoveShouldSetPanResponder</span>: <span class="hljs-function">(<span class="hljs-params">evt, gestureState</span>) =></span> <span class="hljs-literal">true</span>,
<span class="hljs-attr">onMoveShouldSetPanResponderCapture</span>: <span class="hljs-function">(<span class="hljs-params">evt, gestureState</span>) =></span> <span class="hljs-literal">true</span>,
<span class="hljs-attr">onPanResponderGrant</span>: <span class="hljs-function">(<span class="hljs-params">evt, gestureState</span>) =></span> {
<span class="hljs-comment">// The guesture has started. Show visual feedback so the user knows</span>
<span class="hljs-comment">// what is happening!</span>
<span class="hljs-comment">// gestureState.{x,y}0 will be set to zero now</span>
},
<span class="hljs-attr">onPanResponderMove</span>: <span class="hljs-function">(<span class="hljs-params">evt, gestureState</span>) =></span> {
<span class="hljs-comment">// The most recent move distance is gestureState.move{X,Y}</span>
<span class="hljs-comment">// The accumulated gesture distance since becoming responder is</span>
<span class="hljs-comment">// gestureState.d{x,y}</span>
},
<span class="hljs-attr">onPanResponderTerminationRequest</span>: <span class="hljs-function">(<span class="hljs-params">evt, gestureState</span>) =></span> <span class="hljs-literal">true</span>,
<span class="hljs-attr">onPanResponderRelease</span>: <span class="hljs-function">(<span class="hljs-params">evt, gestureState</span>) =></span> {
<span class="hljs-comment">// The user has released all touches while this view is the</span>
<span class="hljs-comment">// responder. This typically means a gesture has succeeded</span>
},
<span class="hljs-attr">onPanResponderTerminate</span>: <span class="hljs-function">(<span class="hljs-params">evt, gestureState</span>) =></span> {
<span class="hljs-comment">// Another component has become the responder, so this gesture</span>
<span class="hljs-comment">// should be cancelled</span>
},
<span class="hljs-attr">onShouldBlockNativeResponder</span>: <span class="hljs-function">(<span class="hljs-params">evt, gestureState</span>) =></span> {
<span class="hljs-comment">// Returns whether this component should block native components from becoming the JS</span>
<span class="hljs-comment">// responder. Returns true by default. Is currently only supported on android.</span>
<span class="hljs-keyword">return</span> <span class="hljs-literal">true</span>;
},
});
},
<span class="hljs-attr">render</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
<span class="hljs-keyword">return</span> (
<span class="xml"><span class="hljs-tag"><<span class="hljs-name">View</span> {<span class="hljs-attr">...this._panResponder.panHandlers</span>} /></span>
);
},
</span></code></pre>
<h3><a class="anchor" aria-hidden="true" id="working-example"></a><a href="#working-example" 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>Working Example</h3>
<p>To see it in action, try the <a href="https://github.com/facebook/react-native/blob/master/Examples/UIExplorer/js/PanResponderExample.js">PanResponder example in UIExplorer</a></p>
<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.34/panresponder#create"><code>create</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="create"></a><a href="#create" 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>create()</code></h3>
<pre><code class="hljs css language-jsx"><span class="token keyword">static</span> <span class="token function">create</span><span class="token punctuation">(</span>config<span class="token punctuation">)</span>
</code></pre>
<p>@param {object} config Enhanced versions of all of the responder callbacks that provide not only the typical <code>ResponderSyntheticEvent</code>, but also the <code>PanResponder</code> gesture state, by replacing the word <code>Responder</code> with <code>PanResponder</code> in each of the typical <code>onResponder*</code> callbacks. For example, the <code>config</code> object would look like:</p>
<ul>
<li><code>onMoveShouldSetPanResponder: (e, gestureState) => {...}</code></li>
<li><code>onMoveShouldSetPanResponderCapture: (e, gestureState) => {...}</code></li>
<li><code>onStartShouldSetPanResponder: (e, gestureState) => {...}</code></li>
<li><code>onStartShouldSetPanResponderCapture: (e, gestureState) => {...}</code></li>
<li><code>onPanResponderReject: (e, gestureState) => {...}</code></li>
<li><code>onPanResponderGrant: (e, gestureState) => {...}</code></li>
<li><code>onPanResponderStart: (e, gestureState) => {...}</code></li>
<li><code>onPanResponderEnd: (e, gestureState) => {...}</code></li>
<li><code>onPanResponderRelease: (e, gestureState) => {...}</code></li>
<li><code>onPanResponderMove: (e, gestureState) => {...}</code></li>
<li><code>onPanResponderTerminate: (e, gestureState) => {...}</code></li>
<li><code>onPanResponderTerminationRequest: (e, gestureState) => {...}</code></li>
<li><code>onShouldBlockNativeResponder: (e, gestureState) => {...}</code></li>
</ul>
<p>In general, for events that have capture equivalents, we update the gestureState once in the capture phase and can use it in the bubble phase as well.</p>
<p>Be careful with <code>onStartShould*</code> callbacks. They only reflect updated <code>gestureState</code> for start/end events that bubble/capture to the Node. Once the node is the responder, you can rely on every start/end event being processed by the gesture and <code>gestureState</code> being updated accordingly. (numberActiveTouches) may not be totally accurate unless you are the responder.</p>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/0.34/netinfo"><span class="arrow-prev">← </span><span>Previous</span></a><a class="docs-next button" href="/docs/0.34/permissionsandroid"><span class="function-name-prevnext">PermissionsAndroid</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="#create"><code>create()</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'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.34"],"hitsPerPage":5}
});
</script></body></html>