Skip to content

[Docs] Document Touchable hover callbacks #4399

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
j-piasecki merged 1 commit into from
Aug 10, 2026
+105 −15
Merged

[Docs] Document Touchable hover callbacks #4399

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 105 additions & 15 deletions packages/docs-gesture-handler/docs/components/touchable.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,13 +373,16 @@ label="Show composed types definitions"
expandedLabel="Hide composed types definitions"
lineBounds={[0, 1]}
src={`
onPressIn?: (e: GestureEvent<NativeHandlerData>) => void;
onPressIn?: (e: ButtonEvent) => void;
type GestureEvent<NativeHandlerData> = {
handlerTag: number;
type ButtonEvent = {
pointerInside: boolean;
x: number;
y: number;
absoluteX: number;
absoluteY: number;
numberOfPointers: number;
pointerType: PointerType;
pointerInside: boolean;
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
enum PointerType {
Expand All @@ -400,13 +403,16 @@ label="Show composed types definitions"
expandedLabel="Hide composed types definitions"
lineBounds={[0, 1]}
src={`
onPressOut?: (e: GestureEvent<NativeHandlerData>) => void;
onPressOut?: (e: ButtonEvent) => void;
type GestureEvent<NativeHandlerData> = {
handlerTag: number;
type ButtonEvent = {
pointerInside: boolean;
x: number;
y: number;
absoluteX: number;
absoluteY: number;
numberOfPointers: number;
pointerType: PointerType;
pointerInside: boolean;
}
enum PointerType {
Expand All @@ -427,13 +433,16 @@ label="Show composed types definitions"
expandedLabel="Hide composed types definitions"
lineBounds={[0, 1]}
src={`
onPress?: (e: GestureEvent<NativeHandlerData>) => void;
onPress?: (e: ButtonEvent) => void;
type GestureEvent<NativeHandlerData> = {
handlerTag: number;
type ButtonEvent = {
pointerInside: boolean;
x: number;
y: number;
absoluteX: number;
absoluteY: number;
numberOfPointers: number;
pointerType: PointerType;
pointerInside: boolean;
}
enum PointerType {
Expand All @@ -449,12 +458,93 @@ Triggered when the button gets pressed (analogous to `onPress` in `Pressable` fr

### onLongPress

```ts
onLongPress?: () => void;
```
<CollapsibleCode
label="Show composed types definitions"
expandedLabel="Hide composed types definitions"
lineBounds={[0, 1]}
src={`
onLongPress?: (e: ButtonEvent) => void;
type ButtonEvent = {
pointerInside: boolean;
x: number;
y: number;
absoluteX: number;
absoluteY: number;
numberOfPointers: number;
pointerType: PointerType;
}
enum PointerType {
TOUCH,
STYLUS,
MOUSE,
KEY,
OTHER,
}
`}/>

Triggered when the button gets pressed for at least [`delayLongPress`](#delaylongpress) milliseconds.

### onHoverIn
Comment thread
j-piasecki marked this conversation as resolved.

<CollapsibleCode
label="Show composed types definitions"
expandedLabel="Hide composed types definitions"
lineBounds={[0, 1]}
src={`
onHoverIn?: (e: ButtonEvent) => void;
type ButtonEvent = {
pointerInside: boolean;
x: number;
y: number;
absoluteX: number;
absoluteY: number;
numberOfPointers: number;
pointerType: PointerType;
Comment thread
j-piasecki marked this conversation as resolved.
}
enum PointerType {
TOUCH,
STYLUS,
MOUSE,
KEY,
OTHER,
}
`}/>

Triggered when a non-touch pointer - a mouse, a trackpad cursor, or a hovering stylus - moves over the button (analogous to `onHoverIn` in `Pressable` from RN core). Touch pointers never report hover.

### onHoverOut

<CollapsibleCode
label="Show composed types definitions"
expandedLabel="Hide composed types definitions"
lineBounds={[0, 1]}
src={`
onHoverOut?: (e: ButtonEvent) => void;
type ButtonEvent = {
pointerInside: boolean;
x: number;
y: number;
absoluteX: number;
absoluteY: number;
numberOfPointers: number;
pointerType: PointerType;
}
enum PointerType {
TOUCH,
STYLUS,
MOUSE,
KEY,
OTHER,
}
`}/>

Triggered when the hovering pointer leaves the button (analogous to `onHoverOut` in `Pressable` from RN core).

### delayLongPress

Expand Down
Loading