PanResponder
PanResponder 将多个触摸协调为一个手势。它使单点触控手势能够抵御额外的触摸,并可用于识别基本的多点触控手势。
默认情况下,PanResponder 会持有一个 InteractionManager 句柄,以阻止长时间运行的 JS 事件打断正在进行的手势。
它为 gesture responder system 提供的 responder 处理函数提供了一个可预测的封装。对于每个处理函数,它都会在原生事件对象旁边提供一个新的 gestureState 对象:
onPanResponderMove: (event, gestureState) => {}
原生事件是一个具有 PressEvent 形式的合成触摸事件。
gestureState 对象包含以下内容:
stateID- gestureState 的 ID;只要屏幕上至少有一个触摸点,就会一直保持不变moveX- 最近一次移动的触摸点的最新屏幕坐标moveY- 最近一次移动的触摸点的最新屏幕坐标x0- responder 被授予时的屏幕坐标y0- responder 被授予时的屏幕坐标dx- 自触摸开始以来手势累计移动的距离dy- 自触摸开始以来手势累计移动的距离vx- 手势当前速度vy- 手势当前速度numberActiveTouches- 当前屏幕上的触摸点数量
使用模式
const ExampleComponent = () => {
const panResponder = useRef(
PanResponder.create({
// 请求成为 responder:
onStartShouldSetPanResponder: (evt, gestureState) => true,
onStartShouldSetPanResponderCapture: (evt, gestureState) =>
true,
onMoveShouldSetPanResponder: (evt, gestureState) => true,
onMoveShouldSetPanResponderCapture: (evt, gestureState) =>
true,
onPanResponderGrant: (evt, gestureState) => {
// 手势已经开始。显示视觉反馈,让用户知道
// 正在发生什么!
// gestureState.d{x,y} 现在将被设为零
},
onPanResponderMove: (evt, gestureState) => {
// 最近的移动距离是 gestureState.move{X,Y}
// 自成为 responder 以来累计的手势距离是
// gestureState.d{x,y}
},
onPanResponderTerminationRequest: (evt, gestureState) =>
true,
onPanResponderRelease: (evt, gestureState) => {
// 当此视图是 responder 时,用户已松开所有触摸点。
// 这通常意味着手势已成功
},
onPanResponderTerminate: (evt, gestureState) => {
// 另一个组件已成为 responder,因此此手势
// 应被取消
},
onShouldBlockNativeResponder: (evt, gestureState) => {
// 返回此组件是否应阻止原生组件成为 JS
// responder。默认返回 true。目前仅在 android 上受支持。
return true;
},
}),
).current;
return <View {...panResponder.panHandlers} />;
};
示例
PanResponder 与 Animated API 配合使用,有助于在 UI 中构建复杂手势。以下示例包含一个可在屏幕上自由拖动的动画 View 组件
试试 RNTester 中的 PanResponder 示例。
参考
方法
create()
static create(config: PanResponderCallbacks): PanResponderInstance;
参数:
| Name | Type | Description |
|---|---|---|
| config Required | object | 参考下文 |
config 对象为所有 responder 回调提供了增强版本,这些回调不仅提供 PressEvent,还提供 PanResponder 手势状态;其方式是在每个典型的 onResponder* 回调中将单词 Responder 替换为 PanResponder。例如,config 对象如下所示:
onMoveShouldSetPanResponder: (e, gestureState) => {...}onMoveShouldSetPanResponderCapture: (e, gestureState) => {...}onStartShouldSetPanResponder: (e, gestureState) => {...}onStartShouldSetPanResponderCapture: (e, gestureState) => {...}onPanResponderReject: (e, gestureState) => {...}onPanResponderGrant: (e, gestureState) => {...}onPanResponderStart: (e, gestureState) => {...}onPanResponderEnd: (e, gestureState) => {...}onPanResponderRelease: (e, gestureState) => {...}onPanResponderMove: (e, gestureState) => {...}onPanResponderTerminate: (e, gestureState) => {...}onPanResponderTerminationRequest: (e, gestureState) => {...}onShouldBlockNativeResponder: (e, gestureState) => {...}
通常,对于具有 capture 对应项的事件,我们会在 capture 阶段更新一次 gestureState,并且也可以在 bubble 阶段使用它。
请谨慎使用 onStartShould* 回调。它们只会反映已经更新的 gestureState,适用于会 bubble/capture 到 Node 的 start/end 事件。一旦该节点成为 responder,你就可以依赖每个 start/end 事件都会被手势处理,并且 gestureState 会相应更新。(numberActiveTouches)在你不是 responder 时可能并不完全准确。