Pressable

Pressable 是一个核心组件包装器，可以检测其定义的任意子元素上的各种按压交互阶段。

tsx

<Pressable onPress={onPressFunction}>
  <Text>I'm pressable!</Text>
</Pressable>

工作原理

在由 Pressable 包装的元素上：

• onPressIn 在按压被激活时调用。
• onPressOut 在按压手势被停用时调用。

在按下 onPressIn 之后，会发生以下两种情况之一：

1. 用户将手指移开，触发 onPressOut，随后触发 onPress。
2. 如果用户在移开手指之前保持手指按压超过 500 毫秒，则触发 onLongPress。（当用户移开手指时，onPressOut 仍会触发。）

手指并不是最精确的仪器，用户意外激活错误的元素或错过激活区域是很常见的。为了提供帮助，Pressable 具有一个可选的 HitRect，你可以使用它来定义触摸可以在距离包装元素多远的地方注册。按压可以在 HitRect 内的任何位置开始。

PressRect 允许按压移出元素及其 HitRect，同时保持激活状态并有资格成为“按压”——想象一下将你按在按钮上的手指慢慢滑开。

触摸区域永远不会超出父视图边界，如果触摸命中两个重叠视图，兄弟视图的 Z-index 始终优先。

你可以使用 hitSlop 设置 HitRect，并使用 pressRetentionOffset 设置 PressRect。

Pressable 使用 React Native 的 Pressability API。有关 Pressability 的状态机流程及其工作原理的更多信息，请查看 Pressability 的实现。

示例

属性

android_disableSound

Android

如果为 true，则在按压时不播放 Android 系统声音。

类型	默认值
boolean	false

android_ripple

Android

启用 Android 涟漪效果并配置其属性。

类型
RippleConfig

children

可以是子节点，也可以是一个函数，该函数接收一个布尔值，反映组件当前是否被按压。

类型
React Node

unstable_pressDelay

按下后等待调用 onPressIn 的持续时间（毫秒）。

类型
number

delayLongPress

从 onPressIn 到调用 onLongPress 的持续时间（毫秒）。

类型	默认值
number	500

disabled

是否禁用按压行为。

类型	默认值
boolean	false

hitSlop

设置元素外部可检测到按压的额外距离。

类型
Rect 或 number

onHoverIn

当悬停被激活以提供视觉反馈时调用。

类型
({ nativeEvent: MouseEvent }) => void

onHoverOut

当悬停被停用以撤销视觉反馈时调用。

类型
({ nativeEvent: MouseEvent }) => void

onLongPress

如果 onPressIn 后的持续时间超过 500 毫秒，则调用。此时间段可通过 delayLongPress 自定义。

类型
({nativeEvent: PressEvent}) => void

onPress

在 onPressOut 之后调用。

类型
({nativeEvent: PressEvent}) => void

onPressIn

当触摸开始时立即调用，在 onPressOut 和 onPress 之前。

类型
({nativeEvent: PressEvent}) => void

onPressMove

当按压位置移动时调用。

类型
({nativeEvent: PressEvent}) => void

onPressOut

当触摸释放时调用。

类型
({nativeEvent: PressEvent}) => void

pressRetentionOffset

在此视图外部的额外距离，在此距离内的触摸在触发 onPressOut 之前仍被视为按压。

类型	默认值
Rect 或 number	{bottom: 30, left: 20, right: 20, top: 20}

style

可以是视图样式，也可以是一个函数，该函数接收一个布尔值反映组件当前是否被按压，并返回视图样式。

类型
View Style 或 ({ pressed: boolean }) => View Style

testOnly_pressed

仅用于文档或测试（例如快照测试）。

类型	默认值
boolean	false

类型定义

RippleConfig

android_ripple 属性的涟漪效果配置。

类型
object

属性：

名称	类型	必填	描述
color	color	否	定义涟漪效果的颜色。
borderless	boolean	否	定义涟漪效果是否不应包含边框。
radius	number	否	定义涟漪效果的半径。
foreground	boolean	否	设置为 true 可将涟漪效果添加到视图的前景而不是背景。如果你的某个子视图有自己的背景，或者你例如正在显示图像，并且你不希望涟漪被它们覆盖，这很有用。