mirror of
https://github.com/facebook/react-native.git
synced 2026-11-18 20:19:07 +00:00
Fix TextInput absorbing scroll gestures on Android (#58678)
Summary:
Pull Request resolved: https://github.com/react/react-native/pull/58678
Fixes the issue described in [#25594](https://github.com/react/react-native/issues/25594) and [#12167](https://github.com/react/react-native/issues/12167), where TextInputs on Android absorb scroll gestures when textAlign is set to "center" or "right". For TextInputs inside a ScrollView, starting a scroll gesture on the TextInput would not scroll the ScrollView.
### Root Cause
The root cause is the `onTouchEvent()` function introduced in [commit 372d001](https://github.com/react/react-native/commit/372d001a5d5e24b68d194e01c356d973642fac86). The smart scroll implementation checks if the TextInput can itself scroll in any direction. If it cannot, then the parent can intercept the gesture to apply normal scroll behavior.
However, when textAlign is set to "center" or "right", `canScrollHorizontally()` returns true, as Android treats the TextInput as capable of scrolling left/right. In these cases, the existing conditional logic blocks all scroll gestures, even if a vertical swipe is applied.
### This PR
Modify `ReactEditText` so that we only check to see if the TextInput can scroll in the direction of the provided touch gesture. If a TextInput can scroll horizontally but not vertically, vertical touch swipes will no longer interfere with the scroll gesture. Touch slop is also used to distinguish intentional swipe gestures from small micro-touch events.
Changelog: [Android][Fixed] - Prevent TextInput from preventing scroll gestures
Reviewed By: Abbondanzo
Differential Revision: D121519676
fbshipit-source-id: 23f78c99213dc0c34c2ae81cce11e706f79ec4e5
This commit is contained in:
1 parent
eff2413a40
commit
99fca5fcaf
2 files changed
+46
-11
No files matched your search
+28
-9
@@ -36,6 +36,7 @@ import android.view.Menu
|
||||
import android.view.MenuItem
|
||||
import android.view.MotionEvent
|
||||
import android.view.View
|
||||
import android.view.ViewConfiguration
|
||||
import android.view.ViewGroup
|
||||
import android.view.accessibility.AccessibilityNodeInfo
|
||||
import android.view.inputmethod.EditorInfo
|
||||
@@ -91,6 +92,7 @@ import com.facebook.react.views.text.internal.span.ReactStrikethroughSpan
|
||||
import com.facebook.react.views.text.internal.span.ReactTextPaintHolderSpan
|
||||
import com.facebook.react.views.text.internal.span.ReactUnderlineSpan
|
||||
import java.util.concurrent.CopyOnWriteArrayList
|
||||
import kotlin.math.abs
|
||||
import kotlin.math.max
|
||||
import kotlin.math.min
|
||||
|
||||
@@ -132,6 +134,9 @@ public open class ReactEditText public constructor(context: Context) : AppCompat
|
||||
private var scrollWatcher: ScrollWatcher?
|
||||
private var keyListener: InternalKeyListener? = null
|
||||
private var detectScrollMovement = false
|
||||
private var touchDownX = 0f
|
||||
private var touchDownY = 0f
|
||||
private val touchSlop = ViewConfiguration.get(context).scaledTouchSlop
|
||||
private var onKeyPress = false
|
||||
private val textAttributes: TextAttributes
|
||||
private var typefaceDirty = false
|
||||
@@ -316,6 +321,8 @@ public open class ReactEditText public constructor(context: Context) : AppCompat
|
||||
override fun onTouchEvent(ev: MotionEvent): Boolean {
|
||||
when (ev.action) {
|
||||
MotionEvent.ACTION_DOWN -> {
|
||||
touchDownX = ev.x
|
||||
touchDownY = ev.y
|
||||
detectScrollMovement = true
|
||||
// Disallow parent views to intercept touch events, until we can detect if we should be
|
||||
// capturing these touches or not.
|
||||
@@ -324,21 +331,33 @@ public open class ReactEditText public constructor(context: Context) : AppCompat
|
||||
|
||||
MotionEvent.ACTION_MOVE ->
|
||||
if (detectScrollMovement) {
|
||||
if (
|
||||
!canScrollVertically(-1) &&
|
||||
!canScrollVertically(1) &&
|
||||
!canScrollHorizontally(-1) &&
|
||||
!canScrollHorizontally(1)
|
||||
) {
|
||||
// We cannot scroll, let parent views take care of these touches.
|
||||
this.parent.requestDisallowInterceptTouchEvent(false)
|
||||
val deltaX = ev.x - touchDownX
|
||||
val deltaY = ev.y - touchDownY
|
||||
val dominantAxisDistance = max(abs(deltaX), abs(deltaY))
|
||||
if (dominantAxisDistance > touchSlop) {
|
||||
if (!canScrollInGestureDirection(deltaX, deltaY)) {
|
||||
// We cannot scroll, let parent views take care of these touches.
|
||||
this.parent.requestDisallowInterceptTouchEvent(false)
|
||||
}
|
||||
detectScrollMovement = false
|
||||
}
|
||||
detectScrollMovement = false
|
||||
}
|
||||
}
|
||||
return super.onTouchEvent(ev)
|
||||
}
|
||||
|
||||
private fun canScrollInGestureDirection(deltaX: Float, deltaY: Float): Boolean {
|
||||
if (abs(deltaY) > abs(deltaX)) {
|
||||
val canScrollUp = deltaY > 0 && canScrollVertically(-1)
|
||||
val canScrollDown = deltaY <= 0 && canScrollVertically(1)
|
||||
return canScrollUp || canScrollDown
|
||||
} else {
|
||||
val canScrollLeft = deltaX > 0 && canScrollHorizontally(-1)
|
||||
val canScrollRight = deltaX <= 0 && canScrollHorizontally(1)
|
||||
return canScrollLeft || canScrollRight
|
||||
}
|
||||
}
|
||||
|
||||
// Consume 'Enter' key events: TextView tries to give focus to the next TextInput, but it can't
|
||||
// since we only allow JS to change focus, which in turn causes TextView to crash.
|
||||
override fun onKeyUp(keyCode: Int, event: KeyEvent): Boolean {
|
||||
|
||||
@@ -471,6 +471,7 @@ const examples: Array<RNTesterModuleExample> = [
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'scrollTextInputsVertical',
|
||||
title: '<ScrollView> TextInputs\n',
|
||||
description:
|
||||
'Vertical scroll gestures on a TextInput should scroll the ScrollView unless the input can also scroll vertically.',
|
||||
@@ -479,6 +480,7 @@ const examples: Array<RNTesterModuleExample> = [
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'scrollTextInputsHorizontal',
|
||||
title: '<ScrollView> TextInputs (horizontal = true)\n',
|
||||
description:
|
||||
'Horizontal scroll gestures on a TextInput should scroll the ScrollView unless the input can also scroll horizontally.',
|
||||
@@ -634,7 +636,7 @@ const VerticalScrollTextInputs = () => {
|
||||
|
||||
return (
|
||||
<View>
|
||||
<RNTesterText style={styles.text}>
|
||||
<RNTesterText style={styles.text} testID="vertical_status">
|
||||
scrolled = {verticalScrolled ? 'true' : 'false'}
|
||||
</RNTesterText>
|
||||
<ScrollView
|
||||
@@ -645,16 +647,22 @@ const VerticalScrollTextInputs = () => {
|
||||
onScroll={event => {
|
||||
setVerticalScrolled(event.nativeEvent.contentOffset.y > 0);
|
||||
}}>
|
||||
<TextInput placeholder="TextInput" style={styles.textInput} />
|
||||
<TextInput
|
||||
placeholder="TextInput"
|
||||
style={styles.textInput}
|
||||
testID="text_input_vertical"
|
||||
/>
|
||||
<TextInput
|
||||
placeholder="TextInput (center)"
|
||||
style={styles.textInput}
|
||||
textAlign="center"
|
||||
testID="text_input_vertical_center"
|
||||
/>
|
||||
<TextInput
|
||||
placeholder="TextInput (right)"
|
||||
style={styles.textInput}
|
||||
textAlign="right"
|
||||
testID="text_input_vertical_right"
|
||||
/>
|
||||
<TextInput
|
||||
defaultValue={
|
||||
@@ -662,6 +670,7 @@ const VerticalScrollTextInputs = () => {
|
||||
}
|
||||
placeholder="TextInput"
|
||||
style={styles.textInput}
|
||||
testID="text_input_vertical_overflow_width"
|
||||
/>
|
||||
<TextInput
|
||||
defaultValue={
|
||||
@@ -670,6 +679,7 @@ const VerticalScrollTextInputs = () => {
|
||||
placeholder="TextInput"
|
||||
style={styles.textInput}
|
||||
multiline
|
||||
testID="text_input_vertical_overflow_height"
|
||||
/>
|
||||
<View
|
||||
style={[styles.textInput, {backgroundColor: '#cccccc', height: 200}]}
|
||||
@@ -682,6 +692,7 @@ const VerticalScrollTextInputs = () => {
|
||||
y: 0,
|
||||
});
|
||||
}}
|
||||
testID="scroll_to_top_button"
|
||||
/>
|
||||
</View>
|
||||
);
|
||||
@@ -711,11 +722,13 @@ const HorizontalScrollTextInputs = () => {
|
||||
styles.textInput,
|
||||
{backgroundColor: '#cccccc', width: 100, height: '100%'},
|
||||
]}
|
||||
testID="left_filler"
|
||||
/>
|
||||
<View style={{gap: 20}}>
|
||||
<TextInput
|
||||
placeholder="TextInput"
|
||||
style={[styles.textInput, {width: 200}]}
|
||||
testID="text_input_horizontal"
|
||||
/>
|
||||
<TextInput
|
||||
defaultValue={
|
||||
@@ -723,6 +736,7 @@ const HorizontalScrollTextInputs = () => {
|
||||
}
|
||||
placeholder="TextInput"
|
||||
style={[styles.textInput, {width: 200}]}
|
||||
testID="text_input_horizontal_overflow_width"
|
||||
/>
|
||||
<TextInput
|
||||
defaultValue={
|
||||
@@ -731,6 +745,7 @@ const HorizontalScrollTextInputs = () => {
|
||||
placeholder="TextInput"
|
||||
style={[styles.textInput, {width: 200}]}
|
||||
multiline
|
||||
testID="text_input_horizontal_overflow_height"
|
||||
/>
|
||||
</View>
|
||||
<View
|
||||
@@ -747,6 +762,7 @@ const HorizontalScrollTextInputs = () => {
|
||||
x: 0,
|
||||
});
|
||||
}}
|
||||
testID="scroll_to_start_button"
|
||||
/>
|
||||
</View>
|
||||
);
|
||||
|
||||
Reference in new issue
Block a user