Skip to content

Commit 0a8da33

Browse files
authored
React events: README update types and remove stopPropagation prop (#15456)
1 parent d584fcd commit 0a8da33

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

packages/react-events/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ const TextField = (props) => (
2929
```js
3030
// Types
3131
type FocusEvent = {
32+
target: Element,
3233
type: 'blur' | 'focus' | 'focuschange'
3334
}
3435
```
@@ -80,6 +81,7 @@ const Link = (props) => (
8081
// Types
8182
type HoverEvent = {
8283
pointerType: 'mouse',
84+
target: Element,
8385
type: 'hoverstart' | 'hoverend' | 'hovermove' | 'hoverchange'
8486
}
8587
```
@@ -123,10 +125,6 @@ be called more than once before `onHoverEnd` is called.
123125

124126
Whether to `preventDefault()` native events.
125127

126-
### stopPropagation: boolean = true
127-
128-
Whether to `stopPropagation()` native events.
129-
130128

131129
## Press
132130

@@ -165,6 +163,7 @@ const Button = (props) => (
165163
// Types
166164
type PressEvent = {
167165
pointerType: 'mouse' | 'touch' | 'pen' | 'keyboard',
166+
target: Element,
168167
type: 'press' | 'pressstart' | 'pressend' | 'presschange' | 'pressmove' | 'longpress' | 'longpresschange'
169168
}
170169

@@ -250,8 +249,9 @@ Ensure you pass in a constant to reduce memory allocations.
250249

251250
### preventDefault: boolean = true
252251

253-
Whether to `preventDefault()` native events.
254-
255-
### stopPropagation: boolean = true
256-
257-
Whether to `stopPropagation()` native events.
252+
Whether to `preventDefault()` native events. Native behavior is prevented by
253+
default. If an anchor is the child of `Press`, internal and external navigation
254+
should be performed in `onPress`/`onLongPress`. To rely on native behavior
255+
instead, set `preventDefault` to `false`, but be aware that native behavior will
256+
take place immediately after interaction without respect for delays or long
257+
press.

0 commit comments

Comments
 (0)