mirror of
https://github.com/facebook/react-native.git
synced 2026-11-18 20:19:07 +00:00
fix: prevent programmatic scrolls from cancelling active touches on iOS (#57546)
Summary:
On iOS, a programmatic non-animated scroll — `scrollTo` / `scrollToOffset({ animated: false })`, or any library driving the offset frame-by-frame — cancels every active touch in enclosing scroll views. Two mechanisms combine into this:
1. `scrollToOffset:animated:` calls `_forceDispatchNextScrollEvent` and, for non-animated scrolls, `_handleFinishedScrolling` — so every call emits `onScroll` (twice) plus `onMomentumScrollEnd`, bypassing `scrollEventThrottle` entirely. A per-frame driver produces a continuous stream of unthrottled `topScroll` events (~60/s measured with `scrollEventThrottle={2000}`).
2. In the responder system, any `topScroll` event without `responderIgnoreScroll: true` starts a responder negotiation, and `ScrollView`'s `onScrollShouldSetResponder` answers `true` whenever a finger is down inside it. Each event therefore steals the responder from a pressed `Pressable`/`Touchable` and the press is cancelled — `onPressIn` fires, `onPress` never does.
On Android scroll events carry `responderIgnoreScroll: true`.
I added `responderIgnoreScroll` to the C++ `ScrollEvent` payload and set it to `!_isUserTriggeredScrolling` in `_scrollViewMetrics`. Programmatic scrolls no longer transfer the responder, while user-initiated scrolls (drag, deceleration, scroll-to-top) keep today's behavior.
## Changelog:
[IOS] [FIXED] - Programmatic (non-user-initiated) scrolls no longer cancel active touches in enclosing scroll views
Pull Request resolved: https://github.com/react/react-native/pull/57546
Test Plan:
Reproducible code — an endless marquee `FlatList` nested in a `ScrollView`, driven by `requestAnimationFrame` + `scrollToOffset({ animated: false })`, with a sibling `TouchableOpacity` and a counter proving the touches reach JS:
<details><summary>App.tsx</summary>
```tsx
import { useEffect, useMemo, useRef, useState } from 'react';
import {
FlatList,
ScrollView,
Text,
TouchableOpacity,
View,
} from 'react-native';
const dpPerSecond = 20;
const size = 80;
const gap = 8;
const data = Array.from({ length: 6 }).map((_, i) => ({
id: `id-${i}`,
n: i + 1,
}));
const renderItem = ({ item }: { item: (typeof data)[0] }) => (
<View
style={{
width: size,
height: size,
backgroundColor: 'red',
justifyContent: 'center',
alignItems: 'center',
}}>
<Text>#{item.n}</Text>
</View>
);
const Carousel = ({ paused }: { paused: boolean }) => {
const ref = useRef<FlatList>(null);
const [width, setWidth] = useState(0);
const offset = useRef(0);
useEffect(() => {
if (paused) return;
const x = (size + gap) * data.length;
let last = Date.now();
let raf: number;
const loop = () => {
const now = Date.now();
offset.current =
(offset.current + (dpPerSecond * (now - last)) / 1000) % x;
last = now;
ref.current?.scrollToOffset({ offset: offset.current, animated: false });
raf = requestAnimationFrame(loop);
};
raf = requestAnimationFrame(loop);
return () => cancelAnimationFrame(raf);
}, [paused]);
const neededToFill = Math.ceil(width / (size + gap));
const extendedData = useMemo(
() => [
...data,
...data.slice(0, neededToFill).map((d) => ({ ...d, id: d.id + '-dup' })),
],
[neededToFill]
);
return (
<FlatList
scrollEnabled={false}
scrollEventThrottle={2000}
showsHorizontalScrollIndicator={false}
windowSize={3}
onLayout={(e) => setWidth(e.nativeEvent.layout.width)}
contentContainerStyle={{ gap }}
ref={ref}
horizontal
data={extendedData}
keyExtractor={(item) => item.id}
renderItem={renderItem}
/>
);
};
export default () => {
const [paused, setPaused] = useState(true);
const [touches, setTouches] = useState(0);
return (
<View style={{ flex: 1 }} onTouchStart={() => setTouches((t) => t + 1)}>
<ScrollView contentContainerStyle={{ paddingVertical: 64, gap: 32 }}>
<Carousel paused={paused} />
<TouchableOpacity onPress={() => setPaused((p) => !p)}>
<Text style={{ fontSize: 20 }}>
Try tapping me {paused ? '▶️' : '⏸️'}
</Text>
</TouchableOpacity>
<Text style={{ fontSize: 16 }}>touches seen by JS: {touches}</Text>
</ScrollView>
</View>
);
};
```
</details>
Before this change, only the first tap works (it starts the marquee); every following tap increments the touch counter but never toggles the button — the press is cancelled by the responder transfer. After this change, every tap toggles the marquee.
Recordings of the repro above (every touch is marked with a blue ring and counted on screen):
Before:
https://github.com/user-attachments/assets/bc5a8764-efe3-40ba-a9cb-a5023d140369
After:
https://github.com/user-attachments/assets/b2c1eea1-dcab-422c-9a4a-90fd69061e9d
Reviewed By: cipolleschi
Differential Revision: D116453881
Pulled By: j-piasecki
fbshipit-source-id: eb72fb0f1a4ac9fdde15f621201009d855d63890
This commit is contained in:
1 parent
63b58b4df7
commit
06eb1fefab
16 files changed
+31
-2
No files matched your search
+1
@@ -597,6 +597,7 @@ static inline UIViewAnimationOptions animationOptionsWithCurve(UIViewAnimationCu
|
||||
metrics.containerSize = RCTSizeFromCGSize(_scrollView.bounds.size);
|
||||
metrics.zoomScale = _scrollView.zoomScale;
|
||||
metrics.timestamp = CACurrentMediaTime();
|
||||
metrics.responderIgnoreScroll = !_isUserTriggeredScrolling;
|
||||
|
||||
if (_layoutMetrics.layoutDirection == LayoutDirection::RightToLeft) {
|
||||
metrics.contentOffset.x = metrics.contentSize.width - metrics.containerSize.width - metrics.contentOffset.x;
|
||||
|
||||
+3
-1
@@ -539,7 +539,9 @@ static NSSet<NSNumber *> *returnKeyTypesSet;
|
||||
- (void)scrollViewDidScroll:(UIScrollView *)scrollView
|
||||
{
|
||||
if (_eventEmitter) {
|
||||
static_cast<const TextInputEventEmitter &>(*_eventEmitter).onScroll([self _textInputMetrics]);
|
||||
auto metrics = [self _textInputMetrics];
|
||||
metrics.responderIgnoreScroll = !(scrollView.isDragging || scrollView.isDecelerating);
|
||||
static_cast<const TextInputEventEmitter &>(*_eventEmitter).onScroll(metrics);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
+3
-1
@@ -44,6 +44,7 @@ jsi::Value ScrollEvent::asJSIValue(jsi::Runtime& runtime) const {
|
||||
|
||||
payload.setProperty(runtime, "zoomScale", zoomScale);
|
||||
payload.setProperty(runtime, "timestamp", timestamp * 1000);
|
||||
payload.setProperty(runtime, "responderIgnoreScroll", responderIgnoreScroll);
|
||||
|
||||
return payload;
|
||||
}
|
||||
@@ -67,7 +68,8 @@ folly::dynamic ScrollEvent::asDynamic() const {
|
||||
"contentInset", std::move(contentInsetObj))(
|
||||
"contentSize", std::move(contentSizeObj))(
|
||||
"layoutMeasurement", std::move(containerSizeObj))(
|
||||
"zoomScale", zoomScale)("timestamp", timestamp * 1000);
|
||||
"zoomScale", zoomScale)("timestamp", timestamp * 1000)(
|
||||
"responderIgnoreScroll", responderIgnoreScroll);
|
||||
|
||||
return metrics;
|
||||
};
|
||||
|
||||
@@ -21,6 +21,7 @@ struct ScrollEvent : public EventPayload {
|
||||
EdgeInsets contentInset;
|
||||
Size containerSize;
|
||||
Float zoomScale{};
|
||||
bool responderIgnoreScroll{false};
|
||||
|
||||
/*
|
||||
* The time in seconds when the touch occurred or when it was last mutated.
|
||||
|
||||
+3
@@ -86,6 +86,9 @@ static jsi::Value textInputMetricsScrollPayload(
|
||||
"zoomScale",
|
||||
textInputMetrics.zoomScale != 0.0f ? textInputMetrics.zoomScale : 1);
|
||||
|
||||
payload.setProperty(
|
||||
runtime, "responderIgnoreScroll", textInputMetrics.responderIgnoreScroll);
|
||||
|
||||
return payload;
|
||||
};
|
||||
|
||||
|
||||
+1
@@ -29,6 +29,7 @@ class TextInputEventEmitter : public ViewEventEmitter {
|
||||
int eventCount;
|
||||
Size layoutMeasurement;
|
||||
Float zoomScale;
|
||||
bool responderIgnoreScroll{false};
|
||||
Tag target;
|
||||
};
|
||||
|
||||
|
||||
+1
@@ -440,6 +440,7 @@ export type TextInputFocusEvent = NativeSyntheticEvent<TextInputFocusEventData>;
|
||||
*/
|
||||
export interface TextInputScrollEventData {
|
||||
contentOffset: {x: number; y: number};
|
||||
responderIgnoreScroll?: boolean | undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -5118,6 +5118,7 @@ struct facebook::react::TextInputEventEmitter::KeyPressMetrics {
|
||||
}
|
||||
|
||||
struct facebook::react::TextInputEventEmitter::Metrics {
|
||||
public bool responderIgnoreScroll;
|
||||
public facebook::react::AttributedString::Range selectionRange;
|
||||
public facebook::react::EdgeInsets contentInset;
|
||||
public facebook::react::Float zoomScale;
|
||||
@@ -7971,6 +7972,7 @@ struct facebook::react::ScrollEndDragEvent : public facebook::react::ScrollEvent
|
||||
|
||||
struct facebook::react::ScrollEvent : public facebook::react::EventPayload {
|
||||
public ScrollEvent() = default;
|
||||
public bool responderIgnoreScroll;
|
||||
public facebook::react::EdgeInsets contentInset;
|
||||
public facebook::react::Float timestamp;
|
||||
public facebook::react::Float zoomScale;
|
||||
|
||||
@@ -4928,6 +4928,7 @@ struct facebook::react::TextInputEventEmitter::KeyPressMetrics {
|
||||
}
|
||||
|
||||
struct facebook::react::TextInputEventEmitter::Metrics {
|
||||
public bool responderIgnoreScroll;
|
||||
public facebook::react::AttributedString::Range selectionRange;
|
||||
public facebook::react::EdgeInsets contentInset;
|
||||
public facebook::react::Float zoomScale;
|
||||
@@ -7731,6 +7732,7 @@ struct facebook::react::ScrollEndDragEvent : public facebook::react::ScrollEvent
|
||||
|
||||
struct facebook::react::ScrollEvent : public facebook::react::EventPayload {
|
||||
public ScrollEvent() = default;
|
||||
public bool responderIgnoreScroll;
|
||||
public facebook::react::EdgeInsets contentInset;
|
||||
public facebook::react::Float timestamp;
|
||||
public facebook::react::Float zoomScale;
|
||||
|
||||
@@ -5109,6 +5109,7 @@ struct facebook::react::TextInputEventEmitter::KeyPressMetrics {
|
||||
}
|
||||
|
||||
struct facebook::react::TextInputEventEmitter::Metrics {
|
||||
public bool responderIgnoreScroll;
|
||||
public facebook::react::AttributedString::Range selectionRange;
|
||||
public facebook::react::EdgeInsets contentInset;
|
||||
public facebook::react::Float zoomScale;
|
||||
@@ -7962,6 +7963,7 @@ struct facebook::react::ScrollEndDragEvent : public facebook::react::ScrollEvent
|
||||
|
||||
struct facebook::react::ScrollEvent : public facebook::react::EventPayload {
|
||||
public ScrollEvent() = default;
|
||||
public bool responderIgnoreScroll;
|
||||
public facebook::react::EdgeInsets contentInset;
|
||||
public facebook::react::Float timestamp;
|
||||
public facebook::react::Float zoomScale;
|
||||
|
||||
@@ -7292,6 +7292,7 @@ struct facebook::react::TextInputEventEmitter::KeyPressMetrics {
|
||||
}
|
||||
|
||||
struct facebook::react::TextInputEventEmitter::Metrics {
|
||||
public bool responderIgnoreScroll;
|
||||
public facebook::react::AttributedString::Range selectionRange;
|
||||
public facebook::react::EdgeInsets contentInset;
|
||||
public facebook::react::Float zoomScale;
|
||||
@@ -9990,6 +9991,7 @@ struct facebook::react::ScrollEndDragEvent : public facebook::react::ScrollEvent
|
||||
|
||||
struct facebook::react::ScrollEvent : public facebook::react::EventPayload {
|
||||
public ScrollEvent() = default;
|
||||
public bool responderIgnoreScroll;
|
||||
public facebook::react::EdgeInsets contentInset;
|
||||
public facebook::react::Float timestamp;
|
||||
public facebook::react::Float zoomScale;
|
||||
|
||||
@@ -7134,6 +7134,7 @@ struct facebook::react::TextInputEventEmitter::KeyPressMetrics {
|
||||
}
|
||||
|
||||
struct facebook::react::TextInputEventEmitter::Metrics {
|
||||
public bool responderIgnoreScroll;
|
||||
public facebook::react::AttributedString::Range selectionRange;
|
||||
public facebook::react::EdgeInsets contentInset;
|
||||
public facebook::react::Float zoomScale;
|
||||
@@ -9806,6 +9807,7 @@ struct facebook::react::ScrollEndDragEvent : public facebook::react::ScrollEvent
|
||||
|
||||
struct facebook::react::ScrollEvent : public facebook::react::EventPayload {
|
||||
public ScrollEvent() = default;
|
||||
public bool responderIgnoreScroll;
|
||||
public facebook::react::EdgeInsets contentInset;
|
||||
public facebook::react::Float timestamp;
|
||||
public facebook::react::Float zoomScale;
|
||||
|
||||
@@ -7283,6 +7283,7 @@ struct facebook::react::TextInputEventEmitter::KeyPressMetrics {
|
||||
}
|
||||
|
||||
struct facebook::react::TextInputEventEmitter::Metrics {
|
||||
public bool responderIgnoreScroll;
|
||||
public facebook::react::AttributedString::Range selectionRange;
|
||||
public facebook::react::EdgeInsets contentInset;
|
||||
public facebook::react::Float zoomScale;
|
||||
@@ -9981,6 +9982,7 @@ struct facebook::react::ScrollEndDragEvent : public facebook::react::ScrollEvent
|
||||
|
||||
struct facebook::react::ScrollEvent : public facebook::react::EventPayload {
|
||||
public ScrollEvent() = default;
|
||||
public bool responderIgnoreScroll;
|
||||
public facebook::react::EdgeInsets contentInset;
|
||||
public facebook::react::Float timestamp;
|
||||
public facebook::react::Float zoomScale;
|
||||
|
||||
@@ -3609,6 +3609,7 @@ struct facebook::react::TextInputEventEmitter::KeyPressMetrics {
|
||||
|
||||
struct facebook::react::TextInputEventEmitter::Metrics {
|
||||
public Float zoomScale;
|
||||
public bool responderIgnoreScroll;
|
||||
public facebook::react::AttributedString::Range selectionRange;
|
||||
public facebook::react::EdgeInsets contentInset;
|
||||
public facebook::react::Point contentOffset;
|
||||
@@ -6092,6 +6093,7 @@ struct facebook::react::ScrollEvent : public facebook::react::EventPayload {
|
||||
public Float timestamp;
|
||||
public Float zoomScale;
|
||||
public ScrollEvent() = default;
|
||||
public bool responderIgnoreScroll;
|
||||
public facebook::react::EdgeInsets contentInset;
|
||||
public facebook::react::Point contentOffset;
|
||||
public facebook::react::Size containerSize;
|
||||
|
||||
@@ -3459,6 +3459,7 @@ struct facebook::react::TextInputEventEmitter::KeyPressMetrics {
|
||||
|
||||
struct facebook::react::TextInputEventEmitter::Metrics {
|
||||
public Float zoomScale;
|
||||
public bool responderIgnoreScroll;
|
||||
public facebook::react::AttributedString::Range selectionRange;
|
||||
public facebook::react::EdgeInsets contentInset;
|
||||
public facebook::react::Point contentOffset;
|
||||
@@ -5916,6 +5917,7 @@ struct facebook::react::ScrollEvent : public facebook::react::EventPayload {
|
||||
public Float timestamp;
|
||||
public Float zoomScale;
|
||||
public ScrollEvent() = default;
|
||||
public bool responderIgnoreScroll;
|
||||
public facebook::react::EdgeInsets contentInset;
|
||||
public facebook::react::Point contentOffset;
|
||||
public facebook::react::Size containerSize;
|
||||
|
||||
@@ -3600,6 +3600,7 @@ struct facebook::react::TextInputEventEmitter::KeyPressMetrics {
|
||||
|
||||
struct facebook::react::TextInputEventEmitter::Metrics {
|
||||
public Float zoomScale;
|
||||
public bool responderIgnoreScroll;
|
||||
public facebook::react::AttributedString::Range selectionRange;
|
||||
public facebook::react::EdgeInsets contentInset;
|
||||
public facebook::react::Point contentOffset;
|
||||
@@ -6083,6 +6084,7 @@ struct facebook::react::ScrollEvent : public facebook::react::EventPayload {
|
||||
public Float timestamp;
|
||||
public Float zoomScale;
|
||||
public ScrollEvent() = default;
|
||||
public bool responderIgnoreScroll;
|
||||
public facebook::react::EdgeInsets contentInset;
|
||||
public facebook::react::Point contentOffset;
|
||||
public facebook::react::Size containerSize;
|
||||
|
||||
Reference in new issue
Block a user