Add dispatch of pointerover/pointerout events

Summary: Changelog: [iOS][Internal] - Add dispatching of pointerover/pointerout events

Reviewed By: lunaleaps

Differential Revision: D36718156

fbshipit-source-id: c2fee2332ac52e617db938e321e3b38fd5c35ad3

Author: vincentriemer

Libraries/NativeComponent/BaseViewConfig.ios.js

@@ -125,6 +125,18 @@ const bubblingEventTypes = {
       skipBubbling: true,
     },
   },
+  topPointerOver: {
+    phasedRegistrationNames: {
+      captured: 'onPointerOverCapture',
+      bubbled: 'onPointerOver',
+    },
+  },
+  topPointerOut: {
+    phasedRegistrationNames: {
+      captured: 'onPointerOutCapture',
+      bubbled: 'onPointerOut',
+    },
+  },
 };
 
 const directEventTypes = {
@@ -315,6 +327,8 @@ const validAttributesForEventProps = ConditionallyIgnoredEventHandlers({
   onPointerEnter2: true,
   onPointerMove2: true,
   onPointerLeave2: true,
+  onPointerOver: true,
+  onPointerOut: true,
 });
 
 /**

React/Fabric/RCTSurfaceTouchHandler.mm

@@ -232,6 +232,16 @@ static BOOL IsViewListeningToEvent(UIView *view, ViewEvents::Offset eventType)
   return NO;
 }
 
+static BOOL IsAnyViewInPathListeningToEvent(NSOrderedSet<UIView *> *viewPath, ViewEvents::Offset eventType)
+{
+  for (UIView *view in viewPath) {
+    if (IsViewListeningToEvent(view, eventType)) {
+      return YES;
+    }
+  }
+  return NO;
+}
+
 /**
  * Surprisingly, `__unsafe_unretained id` pointers are not regular pointers
  * and `std::hash<>` cannot hash them.
@@ -563,11 +573,22 @@ - (void)hovering:(UIHoverGestureRecognizer *)recognizer API_AVAILABLE(ios(13.0))
 
   UIView *targetView = [listenerView hitTest:clientLocation withEvent:nil];
   targetView = FindClosestFabricManagedTouchableView(targetView);
+  UIView *prevTargetView = [_currentlyHoveredViews firstObject];
 
   NSOrderedSet *eventPathViews = GetTouchableViewsInPathToRoot(targetView);
 
   NSTimeInterval timestamp = CACurrentMediaTime();
 
+  // Over
+  if (prevTargetView != targetView) {
+    BOOL shouldEmitOverEvent = IsAnyViewInPathListeningToEvent(eventPathViews, ViewEvents::Offset::PointerOver);
+    SharedTouchEventEmitter eventEmitter = GetTouchEmitterFromView(targetView, [recognizer locationInView:targetView]);
+    if (shouldEmitOverEvent && eventEmitter != nil) {
+      PointerEvent event = CreatePointerEventFromIncompleteHoverData(targetView, clientLocation, timestamp);
+      eventEmitter->onPointerOver(event);
+    }
+  }
+
   // Entering
 
   // We only want to emit events to JS if there is a view that is currently listening to said event
@@ -595,6 +616,17 @@ - (void)hovering:(UIHoverGestureRecognizer *)recognizer API_AVAILABLE(ios(13.0))
     }
   }
 
+  // Out
+  if (prevTargetView != targetView) {
+    BOOL shouldEmitOutEvent = IsAnyViewInPathListeningToEvent(_currentlyHoveredViews, ViewEvents::Offset::PointerOut);
+    SharedTouchEventEmitter eventEmitter =
+        GetTouchEmitterFromView(prevTargetView, [recognizer locationInView:prevTargetView]);
+    if (shouldEmitOutEvent && eventEmitter != nil) {
+      PointerEvent event = CreatePointerEventFromIncompleteHoverData(prevTargetView, clientLocation, timestamp);
+      eventEmitter->onPointerOut(event);
+    }
+  }
+
   // Leaving
 
   // pointerleave events need to be emited from the deepest target to the root but

React/Views/RCTView.h

@@ -112,5 +112,7 @@ extern const UIAccessibilityTraits SwitchAccessibilityTrait;
 @property (nonatomic, assign) RCTBubblingEventBlock onPointerUp;
 @property (nonatomic, assign) RCTCapturingEventBlock onPointerEnter2;
 @property (nonatomic, assign) RCTCapturingEventBlock onPointerLeave2;
+@property (nonatomic, assign) RCTBubblingEventBlock onPointerOver;
+@property (nonatomic, assign) RCTBubblingEventBlock onPointerOut;
 
 @end

React/Views/RCTViewManager.m

@@ -452,5 +452,7 @@ - (RCTShadowView *)shadowView
 RCT_EXPORT_VIEW_PROPERTY(onPointerUp, RCTBubblingEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onPointerEnter2, RCTCapturingEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onPointerLeave2, RCTCapturingEventBlock)
+RCT_EXPORT_VIEW_PROPERTY(onPointerOver, RCTBubblingEventBlock)
+RCT_EXPORT_VIEW_PROPERTY(onPointerOut, RCTBubblingEventBlock)
 
 @end

ReactCommon/react/renderer/components/view/TouchEventEmitter.cpp

@@ -177,5 +177,21 @@ void TouchEventEmitter::onPointerLeave2(const PointerEvent &event) const {
       RawEvent::Category::ContinuousEnd);
 }
 
+void TouchEventEmitter::onPointerOver(const PointerEvent &event) const {
+  dispatchPointerEvent(
+      "pointerOver",
+      event,
+      EventPriority::AsynchronousBatched,
+      RawEvent::Category::ContinuousStart);
+}
+
+void TouchEventEmitter::onPointerOut(const PointerEvent &event) const {
+  dispatchPointerEvent(
+      "pointerOut",
+      event,
+      EventPriority::AsynchronousBatched,
+      RawEvent::Category::ContinuousStart);
+}
+
 } // namespace react
 } // namespace facebook

ReactCommon/react/renderer/components/view/TouchEventEmitter.h

@@ -36,6 +36,8 @@ class TouchEventEmitter : public EventEmitter {
   void onPointerUp(PointerEvent const &event) const;
   void onPointerEnter2(PointerEvent const &event) const;
   void onPointerLeave2(PointerEvent const &event) const;
+  void onPointerOver(PointerEvent const &event) const;
+  void onPointerOut(PointerEvent const &event) const;
 
  private:
   void dispatchTouchEvent(

ReactCommon/react/renderer/components/view/primitives.h

@@ -57,6 +57,8 @@ struct ViewEvents {
     PointerEnter2Capture = 23,
     PointerLeave2Capture = 24,
     PointerMove2Capture = 25,
+    PointerOver = 26,
+    PointerOut = 27,
   };
 
   constexpr bool operator[](const Offset offset) const {

ReactCommon/react/renderer/components/view/propsConversions.h

@@ -529,6 +529,18 @@ static inline ViewEvents convertRawProp(
       "onPointerLeave2Capture",
       sourceValue[Offset::PointerLeave2Capture],
       defaultValue[Offset::PointerLeave2Capture]);
+  result[Offset::PointerOver] = convertRawProp(
+      context,
+      rawProps,
+      "onPointerOver",
+      sourceValue[Offset::PointerOver],
+      defaultValue[Offset::PointerOver]);
+  result[Offset::PointerOut] = convertRawProp(
+      context,
+      rawProps,
+      "onPointerOut",
+      sourceValue[Offset::PointerOut],
+      defaultValue[Offset::PointerOut]);
 
   // PanResponder callbacks
   result[Offset::MoveShouldSetResponder] = convertRawProp(