跳到主要内容
版本:0.81

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 - 当前屏幕上的触摸点数量

使用模式

React TSX
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} 将被设为 0
},
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()

React TSX
static create(config: PanResponderCallbacks): PanResponderInstance;

参数:

NameTypeDescription
config
Required
object参考下文

config 对象为所有 responder 回调提供了增强版本:它不仅提供 PressEvent,还通过将每个典型的 onResponder* 回调中的 Responder 替换为 PanResponder,同时提供 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* 回调。它们只会反映会 bubble/capture 到 Node 的 start/end 事件的更新后 gestureState。一旦该节点成为 responder,你就可以依赖每个 start/end 事件都由手势处理,并且 gestureState 会相应更新。若你不是 responder,numberActiveTouches 可能并不完全准确。