Skip to content

Commit 897cca8

Browse files
authored
Respect pointerEvents on Android SafeAreaView (#59881)
Summary: Android `SafeAreaView` ignored the `pointerEvents` prop, so a `SafeAreaView` with `pointerEvents="box-none"` still caught touches outside its children instead of passing them to the views underneath. The `SafeAreaView` native component spec now declares `pointerEvents`, so the generated `SafeAreaViewManagerDelegate` passes it to `ReactSafeAreaViewManager.setPointerEvents`, and `ReactSafeAreaView` implements `ReactPointerEventsView`. Without the prop it stays `AUTO`, so existing behavior is unchanged. Changelog: [Android][Fixed] - SafeAreaView now respects pointerEvents Differential Revision: D127611314 Pull Request resolved: #59881
1 parent ffb2e8d commit 897cca8

14 files changed

Lines changed: 219 additions & 2 deletions

File tree

‎packages/react-native/ReactAndroid/api/ReactAndroid.api‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5126,6 +5126,7 @@ public class com/facebook/react/viewmanagers/SafeAreaViewManagerDelegate : com/f
51265126
}
51275127

51285128
public abstract interface class com/facebook/react/viewmanagers/SafeAreaViewManagerInterface : com/facebook/react/uimanager/ViewManagerWithGeneratedInterface {
5129+
public abstract fun setPointerEvents (Landroid/view/View;Ljava/lang/String;)V
51295130
}
51305131

51315132
public class com/facebook/react/viewmanagers/UnimplementedNativeViewManagerDelegate : com/facebook/react/uimanager/BaseViewManagerDelegate {

‎packages/react-native/ReactAndroid/src/main/java/com/facebook/react/views/safeareaview/ReactSafeAreaView.kt‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,17 @@ import com.facebook.react.bridge.GuardedRunnable
1717
import com.facebook.react.bridge.WritableNativeMap
1818
import com.facebook.react.common.build.ReactBuildConfig
1919
import com.facebook.react.uimanager.PixelUtil.pxToDp
20+
import com.facebook.react.uimanager.PointerEvents
21+
import com.facebook.react.uimanager.ReactPointerEventsView
2022
import com.facebook.react.uimanager.StateWrapper
2123
import com.facebook.react.uimanager.ThemedReactContext
2224

23-
internal class ReactSafeAreaView(val reactContext: ThemedReactContext) : ViewGroup(reactContext) {
25+
internal class ReactSafeAreaView(val reactContext: ThemedReactContext) :
26+
ViewGroup(reactContext), ReactPointerEventsView {
2427
internal var stateWrapper: StateWrapper? = null
2528

29+
override var pointerEvents: PointerEvents = PointerEvents.AUTO
30+
2631
override fun onAttachedToWindow() {
2732
super.onAttachedToWindow()
2833

‎packages/react-native/ReactAndroid/src/main/java/com/facebook/react/views/safeareaview/ReactSafeAreaViewManager.kt‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,14 @@
88
package com.facebook.react.views.safeareaview
99

1010
import com.facebook.react.module.annotations.ReactModule
11+
import com.facebook.react.uimanager.PointerEvents
1112
import com.facebook.react.uimanager.ReactStylesDiffMap
1213
import com.facebook.react.uimanager.StateWrapper
1314
import com.facebook.react.uimanager.ThemedReactContext
1415
import com.facebook.react.uimanager.ViewGroupManager
1516
import com.facebook.react.uimanager.ViewManagerDelegate
17+
import com.facebook.react.uimanager.ViewProps
18+
import com.facebook.react.uimanager.annotations.ReactProp
1619
import com.facebook.react.viewmanagers.SafeAreaViewManagerDelegate
1720
import com.facebook.react.viewmanagers.SafeAreaViewManagerInterface
1821

@@ -30,6 +33,11 @@ internal class ReactSafeAreaViewManager :
3033

3134
override fun getName(): String = REACT_CLASS
3235

36+
@ReactProp(name = ViewProps.POINTER_EVENTS)
37+
override fun setPointerEvents(view: ReactSafeAreaView, value: String?) {
38+
view.pointerEvents = PointerEvents.parsePointerEvents(value)
39+
}
40+
3341
@Suppress("DEPRECATION")
3442
override fun createShadowNodeInstance(): com.facebook.react.uimanager.LayoutShadowNode =
3543
com.facebook.react.uimanager.LayoutShadowNode()
Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
/*
2+
* Copyright (c) Meta Platforms, Inc. and affiliates.
3+
*
4+
* This source code is licensed under the MIT license found in the
5+
* LICENSE file in the root directory of this source tree.
6+
*/
7+
8+
package com.facebook.react.views.safeareaview
9+
10+
import android.widget.FrameLayout
11+
import com.facebook.react.bridge.JavaOnlyMap
12+
import com.facebook.react.bridge.ReactTestHelper.createTestReactApplicationContext
13+
import com.facebook.react.internal.featureflags.ReactNativeFeatureFlagsForTests
14+
import com.facebook.react.uimanager.PointerEvents
15+
import com.facebook.react.uimanager.ReactStylesDiffMap
16+
import com.facebook.react.uimanager.ThemedReactContext
17+
import com.facebook.react.uimanager.TouchTargetHelper
18+
import com.facebook.react.views.view.ReactViewGroup
19+
import com.facebook.testutils.shadows.ShadowSoLoader
20+
import org.assertj.core.api.Assertions.assertThat
21+
import org.junit.Before
22+
import org.junit.Test
23+
import org.junit.runner.RunWith
24+
import org.robolectric.RobolectricTestRunner
25+
import org.robolectric.RuntimeEnvironment
26+
import org.robolectric.annotation.Config
27+
28+
@RunWith(RobolectricTestRunner::class)
29+
@Config(shadows = [ShadowSoLoader::class])
30+
class ReactSafeAreaViewManagerTest {
31+
32+
private lateinit var themedContext: ThemedReactContext
33+
private lateinit var root: FrameLayout
34+
private lateinit var safeArea: ReactSafeAreaView
35+
private val manager = ReactSafeAreaViewManager()
36+
37+
@Before
38+
fun setUp() {
39+
ReactNativeFeatureFlagsForTests.setUp()
40+
val context = createTestReactApplicationContext(RuntimeEnvironment.getApplication())
41+
themedContext = ThemedReactContext(context, context, null, -1)
42+
43+
root = FrameLayout(themedContext)
44+
root.id = ROOT_TAG
45+
root.measure(500, 500)
46+
root.layout(0, 0, 500, 500)
47+
48+
val underlying = ReactViewGroup(themedContext)
49+
underlying.id = UNDERLYING_TAG
50+
root.addView(underlying)
51+
underlying.layout(0, 0, 500, 500)
52+
53+
safeArea = ReactSafeAreaView(themedContext)
54+
safeArea.id = SAFE_AREA_TAG
55+
root.addView(safeArea)
56+
safeArea.layout(0, 300, 500, 500)
57+
58+
val toast = ReactViewGroup(themedContext)
59+
toast.id = TOAST_TAG
60+
safeArea.addView(toast)
61+
toast.layout(100, 0, 400, 100)
62+
}
63+
64+
@Test
65+
fun boxNone_touchOutsideChildrenReachesViewUnderneath() {
66+
setPointerEvents("box-none")
67+
68+
assertThat(TouchTargetHelper.findTargetTagForTouch(20f, 380f, root)).isEqualTo(UNDERLYING_TAG)
69+
}
70+
71+
@Test
72+
fun boxNone_touchOnChildStillReachesChild() {
73+
setPointerEvents("box-none")
74+
75+
assertThat(TouchTargetHelper.findTargetTagForTouch(200f, 350f, root)).isEqualTo(TOAST_TAG)
76+
}
77+
78+
@Test
79+
fun withoutPointerEvents_safeAreaViewReceivesTouchOutsideChildren() {
80+
assertThat(TouchTargetHelper.findTargetTagForTouch(20f, 380f, root)).isEqualTo(SAFE_AREA_TAG)
81+
}
82+
83+
@Test
84+
fun resettingPointerEvents_restoresDefaultHitTesting() {
85+
setPointerEvents("box-none")
86+
setPointerEvents(null)
87+
88+
assertThat(TouchTargetHelper.findTargetTagForTouch(20f, 380f, root)).isEqualTo(SAFE_AREA_TAG)
89+
}
90+
91+
@Test
92+
fun invalidPointerEvents_restoresDefaultHitTesting() {
93+
setPointerEvents("box-none")
94+
assertThat(TouchTargetHelper.findTargetTagForTouch(20f, 380f, root)).isEqualTo(UNDERLYING_TAG)
95+
96+
setPointerEvents("BoX-InVaLiD")
97+
98+
assertThat(safeArea.pointerEvents).isEqualTo(PointerEvents.AUTO)
99+
assertThat(TouchTargetHelper.findTargetTagForTouch(20f, 380f, root)).isEqualTo(SAFE_AREA_TAG)
100+
assertThat(TouchTargetHelper.findTargetTagForTouch(200f, 350f, root)).isEqualTo(TOAST_TAG)
101+
}
102+
103+
private fun setPointerEvents(value: String?) {
104+
manager.updateProperties(safeArea, ReactStylesDiffMap(JavaOnlyMap.of("pointerEvents", value)))
105+
}
106+
107+
private companion object {
108+
const val ROOT_TAG = 1
109+
const val UNDERLYING_TAG = 2
110+
const val SAFE_AREA_TAG = 3
111+
const val TOAST_TAG = 4
112+
}
113+
}

‎packages/react-native/src/private/components/safeareaview/specs/RCTSafeAreaViewNativeComponent.js‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,19 @@
99
*/
1010

1111
import type {ViewProps} from '../../../../../Libraries/Components/View/ViewPropTypes';
12+
import type {WithDefault} from '../../../../../Libraries/Types/CodegenTypes';
1213
import type {HostComponent} from '../../../types/HostComponent';
1314

1415
import codegenNativeComponent from '../../../../../Libraries/Utilities/codegenNativeComponent';
1516

1617
type RCTSafeAreaViewNativeProps = Readonly<{
1718
...ViewProps,
1819

19-
// No props
20+
// Declared so the generated Android delegate applies it to the native view.
21+
pointerEvents?: WithDefault<
22+
'auto' | 'box-none' | 'box-only' | 'none',
23+
'auto',
24+
>,
2025
}>;
2126

2227
export default codegenNativeComponent<RCTSafeAreaViewNativeProps>(

‎packages/rn-tester/NativeComponentExample/GeneratedPropsStrictApiTest.cpp‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,32 @@
66
*/
77

88
#include <react/renderer/components/AppSpecs/Props.h>
9+
#include <react/renderer/components/FBReactNativeSpec/Props.h>
910

1011
#include <gtest/gtest.h>
1112

1213
namespace facebook::react {
1314

1415
TEST(GeneratedPropsStrictApiTest, generatedHeaderCompiles) {}
1516

17+
TEST(GeneratedPropsStrictApiTest, unknownPointerEventsUsesDeclaredDefault) {
18+
ContextContainer contextContainer;
19+
PropsParserContext context{-1, contextContainer};
20+
auto pointerEvents = SafeAreaViewPointerEvents::BoxNone;
21+
22+
fromRawValue(context, RawValue{folly::dynamic("invalid")}, pointerEvents);
23+
24+
EXPECT_EQ(pointerEvents, SafeAreaViewPointerEvents::Auto);
25+
}
26+
27+
TEST(GeneratedPropsStrictApiTest, knownPointerEventsPreservesRequestedValue) {
28+
ContextContainer contextContainer;
29+
PropsParserContext context{-1, contextContainer};
30+
auto pointerEvents = SafeAreaViewPointerEvents::Auto;
31+
32+
fromRawValue(context, RawValue{folly::dynamic("box-none")}, pointerEvents);
33+
34+
EXPECT_EQ(pointerEvents, SafeAreaViewPointerEvents::BoxNone);
35+
}
36+
1637
} // namespace facebook::react

‎scripts/cxx-api/api-snapshots/ReactAndroidDebugCxx.api‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2200,6 +2200,7 @@ class facebook::react::SafeAreaViewEventEmitter : public facebook::react::BaseVi
22002200
class facebook::react::SafeAreaViewProps : public facebook::react::HostPlatformViewProps {
22012201
public SafeAreaViewProps() = default;
22022202
public SafeAreaViewProps(const facebook::react::PropsParserContext& context, const facebook::react::SafeAreaViewProps& sourceProps, const facebook::react::RawProps& rawProps);
2203+
public facebook::react::SafeAreaViewPointerEvents pointerEvents;
22032204
public virtual facebook::react::ComponentName getDiffPropsImplementationTarget() const override;
22042205
public virtual folly::dynamic getDiffProps(const facebook::react::Props* prevProps) const override;
22052206
}
@@ -3000,6 +3001,13 @@ enum facebook::react::Role : uint8_t {
30003001
Treeitem,
30013002
}
30023003

3004+
enum facebook::react::SafeAreaViewPointerEvents {
3005+
Auto,
3006+
BoxNone,
3007+
BoxOnly,
3008+
None,
3009+
}
3010+
30033011
enum facebook::react::SchedulerPriority : int {
30043012
IdlePriority,
30053013
ImmediatePriority,

‎scripts/cxx-api/api-snapshots/ReactAndroidFrameworksCxx.api‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3516,6 +3516,7 @@ class facebook::react::SafeAreaViewEventEmitter : public facebook::react::BaseVi
35163516
class facebook::react::SafeAreaViewProps : public facebook::react::HostPlatformViewProps {
35173517
public SafeAreaViewProps() = default;
35183518
public SafeAreaViewProps(const facebook::react::PropsParserContext& context, const facebook::react::SafeAreaViewProps& sourceProps, const facebook::react::RawProps& rawProps);
3519+
public facebook::react::SafeAreaViewPointerEvents pointerEvents;
35193520
public virtual facebook::react::ComponentName getDiffPropsImplementationTarget() const override;
35203521
public virtual folly::dynamic getDiffProps(const facebook::react::Props* prevProps) const override;
35213522
}
@@ -5350,6 +5351,13 @@ enum facebook::react::Role : uint8_t {
53505351
Treeitem,
53515352
}
53525353

5354+
enum facebook::react::SafeAreaViewPointerEvents {
5355+
Auto,
5356+
BoxNone,
5357+
BoxOnly,
5358+
None,
5359+
}
5360+
53535361
enum facebook::react::SchedulerPriority : int {
53545362
IdlePriority,
53555363
ImmediatePriority,

‎scripts/cxx-api/api-snapshots/ReactAndroidNewarchCxx.api‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2199,6 +2199,7 @@ class facebook::react::SafeAreaViewEventEmitter : public facebook::react::BaseVi
21992199
class facebook::react::SafeAreaViewProps : public facebook::react::HostPlatformViewProps {
22002200
public SafeAreaViewProps() = default;
22012201
public SafeAreaViewProps(const facebook::react::PropsParserContext& context, const facebook::react::SafeAreaViewProps& sourceProps, const facebook::react::RawProps& rawProps);
2202+
public facebook::react::SafeAreaViewPointerEvents pointerEvents;
22022203
public virtual facebook::react::ComponentName getDiffPropsImplementationTarget() const override;
22032204
public virtual folly::dynamic getDiffProps(const facebook::react::Props* prevProps) const override;
22042205
}
@@ -2993,6 +2994,13 @@ enum facebook::react::Role : uint8_t {
29932994
Treeitem,
29942995
}
29952996

2997+
enum facebook::react::SafeAreaViewPointerEvents {
2998+
Auto,
2999+
BoxNone,
3000+
BoxOnly,
3001+
None,
3002+
}
3003+
29963004
enum facebook::react::SchedulerPriority : int {
29973005
IdlePriority,
29983006
ImmediatePriority,

‎scripts/cxx-api/api-snapshots/ReactAndroidReleaseCxx.api‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2199,6 +2199,7 @@ class facebook::react::SafeAreaViewEventEmitter : public facebook::react::BaseVi
21992199
class facebook::react::SafeAreaViewProps : public facebook::react::HostPlatformViewProps {
22002200
public SafeAreaViewProps() = default;
22012201
public SafeAreaViewProps(const facebook::react::PropsParserContext& context, const facebook::react::SafeAreaViewProps& sourceProps, const facebook::react::RawProps& rawProps);
2202+
public facebook::react::SafeAreaViewPointerEvents pointerEvents;
22022203
public virtual facebook::react::ComponentName getDiffPropsImplementationTarget() const override;
22032204
public virtual folly::dynamic getDiffProps(const facebook::react::Props* prevProps) const override;
22042205
}
@@ -2993,6 +2994,13 @@ enum facebook::react::Role : uint8_t {
29932994
Treeitem,
29942995
}
29952996

2997+
enum facebook::react::SafeAreaViewPointerEvents {
2998+
Auto,
2999+
BoxNone,
3000+
BoxOnly,
3001+
None,
3002+
}
3003+
29963004
enum facebook::react::SchedulerPriority : int {
29973005
IdlePriority,
29983006
ImmediatePriority,

0 commit comments

Comments
 (0)