跳到主要内容

PanResponder

PanResponder 将多个触摸事件协调为一个手势。它使单触手势对额外的触摸具有弹性,并且可以用于识别基本的多点触控手势。

默认情况下,PanResponder 持有 InteractionManager 句柄,以阻止长时间运行的 JS 事件中断活动手势。

它提供了 手势响应系统 提供的响应器处理程序的预测性包装器。对于每个处理程序,它会提供一个新的 gestureState 对象以及原生事件对象。

onPanResponderMove: (event, gestureState) => {}

原生事件是合成触摸事件,形式为 PressEvent

gestureState 对象具有以下属性:

  • stateID - gestureState 的 ID - 只要屏幕上至少有一个触摸,该 ID 就会持续存在
  • moveX - 最近移动的触摸的最新屏幕坐标
  • moveY - 最近移动的触摸的最新屏幕坐标
  • x0 - 响应器授权的屏幕坐标
  • y0 - 响应器授权的屏幕坐标
  • dx - 自触摸开始以来手势的累计距离
  • dy - 自触摸开始以来手势的累计距离
  • vx - 手势的当前速度
  • vy - 手势的当前速度
  • numberActiveTouches - 当前屏幕上的触摸数量

使用模式

tsx
const ExampleComponent = () => {
const panResponder = React.useRef(
PanResponder.create({
// Ask to be the responder:
onStartShouldSetPanResponder: (evt, gestureState) => true,
onStartShouldSetPanResponderCapture: (evt, gestureState) =>
true,
onMoveShouldSetPanResponder: (evt, gestureState) => true,
onMoveShouldSetPanResponderCapture: (evt, gestureState) =>
true,

onPanResponderGrant: (evt, gestureState) => {
// The gesture has started. Show visual feedback so the user knows
// what is happening!
// gestureState.d{x,y} will be set to zero now
},
onPanResponderMove: (evt, gestureState) => {
// The most recent move distance is gestureState.move{X,Y}
// The accumulated gesture distance since becoming responder is
// gestureState.d{x,y}
},
onPanResponderTerminationRequest: (evt, gestureState) =>
true,
onPanResponderRelease: (evt, gestureState) => {
// The user has released all touches while this view is the
// responder. This typically means a gesture has succeeded
},
onPanResponderTerminate: (evt, gestureState) => {
// Another component has become the responder, so this gesture
// should be cancelled
},
onShouldBlockNativeResponder: (evt, gestureState) => {
// Returns whether this component should block native components from becoming the JS
// responder. Returns true by default. Is currently only supported on android.
return true;
},
}),
).current;

return <View {...panResponder.panHandlers} />;
};

示例

PanResponderAnimated API 配合使用,有助于在 UI 中构建复杂手势。以下示例包含一个可自由拖动到屏幕上的动画 View 组件

在 RNTester 中尝试 PanResponder 示例


参考

方法

create()

tsx
static create(config: PanResponderCallbacks): PanResponderInstance;

参数

姓名类型描述
配置
必需
对象请参考下面

config 对象提供了所有响应器回调的增强版本,它们不仅提供了 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) => {...}

一般来说,对于具有捕获等效事件的事件,我们会在捕获阶段更新一次 gestureState,并且在冒泡阶段也可以使用它。

请注意 onStartShould* 回调。它们仅反映了冒泡/捕获到节点的开始/结束事件的更新 gestureState。一旦节点是响应器,您就可以依赖于每个开始/结束事件都由手势处理,并且 gestureState 会相应更新。(numberActiveTouches)可能不完全准确,除非您是响应器。