[Fabric] implement tooltip property (microsoft#13941)

* [Fabric] implement view tooltip property * format * Change files * update * Fix lingering tooltip if component is unmounted while tooltip showing * snapshot --------- Co-authored-by: Jon Thysell <jthysell@microsoft.com>
acoates-ms · Oct 16, 2024 · 12997d1 · 12997d1
1 parent 10abaca
commit 12997d1
Show file tree

Hide file tree

Showing 24 changed files with 553 additions and 18 deletions.
diff --git a/change/react-native-windows-4cf47ab7-542b-4ccb-bc2e-46c79be1bb02.json b/change/react-native-windows-4cf47ab7-542b-4ccb-bc2e-46c79be1bb02.json
@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "[Fabric] implement view tooltip property",
+  "packageName": "react-native-windows",
+  "email": "30809111+acoates-ms@users.noreply.github.com",
+  "dependentChangeType": "patch"
+}
diff --git a/packages/e2e-test-app-fabric/test/__snapshots__/ViewComponentTest.test.ts.snap b/packages/e2e-test-app-fabric/test/__snapshots__/ViewComponentTest.test.ts.snap
@@ -6023,12 +6023,24 @@ exports[`View Tests Views can have tooltips 1`] = `
         "_Props": {},
       },
       {
-        "Type": "Microsoft.ReactNative.Composition.ParagraphComponentView",
+        "Type": "Microsoft.ReactNative.Composition.ViewComponentView",
         "_Props": {},
+        "__Children": [
+          {
+            "Type": "Microsoft.ReactNative.Composition.ParagraphComponentView",
+            "_Props": {},
+          },
+        ],
       },
       {
-        "Type": "Microsoft.ReactNative.Composition.ParagraphComponentView",
+        "Type": "Microsoft.ReactNative.Composition.ViewComponentView",
         "_Props": {},
+        "__Children": [
+          {
+            "Type": "Microsoft.ReactNative.Composition.ParagraphComponentView",
+            "_Props": {},
+          },
+        ],
       },
     ],
   },
@@ -6064,6 +6076,25 @@ exports[`View Tests Views can have tooltips 1`] = `
             "Offset": "0, 0, 0",
             "Size": "916, 15",
             "Visual Type": "SpriteVisual",
+            "__Children": [
+              {
+                "Offset": "0, 0, 0",
+                "Size": "916, 15",
+                "Visual Type": "SpriteVisual",
+                "__Children": [
+                  {
+                    "Offset": "0, 0, 0",
+                    "Size": "916, 15",
+                    "Visual Type": "SpriteVisual",
+                  },
+                  {
+                    "Offset": "0, 0, 0",
+                    "Size": "0, 0",
+                    "Visual Type": "SpriteVisual",
+                  },
+                ],
+              },
+            ],
           },
           {
             "Offset": "0, 0, 0",
@@ -6074,13 +6105,32 @@ exports[`View Tests Views can have tooltips 1`] = `
       },
       {
         "Offset": "0, 29, 0",
-        "Size": "916, 16",
+        "Size": "916, 14",
         "Visual Type": "SpriteVisual",
         "__Children": [
           {
             "Offset": "0, 0, 0",
-            "Size": "916, 16",
+            "Size": "916, 14",
             "Visual Type": "SpriteVisual",
+            "__Children": [
+              {
+                "Offset": "0, 0, 0",
+                "Size": "916, 16",
+                "Visual Type": "SpriteVisual",
+                "__Children": [
+                  {
+                    "Offset": "0, 0, 0",
+                    "Size": "916, 16",
+                    "Visual Type": "SpriteVisual",
+                  },
+                  {
+                    "Offset": "0, 0, 0",
+                    "Size": "0, 0",
+                    "Visual Type": "SpriteVisual",
+                  },
+                ],
+              },
+            ],
           },
           {
             "Offset": "0, 0, 0",

diff --git a/vnext/Desktop.DLL/React.Windows.Desktop.DLL.vcxproj b/vnext/Desktop.DLL/React.Windows.Desktop.DLL.vcxproj
@@ -103,6 +103,7 @@
         comsuppw.lib;
         Shlwapi.lib;
         Version.lib;
+        Dwmapi.lib;
         WindowsApp_downlevel.lib;
         %(AdditionalDependencies)
       </AdditionalDependencies>

diff --git a/vnext/Microsoft.ReactNative/Fabric/ComponentView.cpp b/vnext/Microsoft.ReactNative/Fabric/ComponentView.cpp
@@ -14,6 +14,7 @@
 #include <Fabric/Composition/RootComponentView.h>
 #include "AbiEventEmitter.h"
 #include "AbiShadowNode.h"
+#include "ReactCoreInjection.h"
 
 namespace winrt::Microsoft::ReactNative::Composition::implementation {
 struct RootComponentView;
@@ -262,6 +263,17 @@ void ComponentView::HandleCommand(const winrt::Microsoft::ReactNative::HandleCom
   }
 }
 
+HWND ComponentView::GetHwndForParenting() noexcept {
+  if (m_parent) {
+    return winrt::get_self<winrt::Microsoft::ReactNative::implementation::ComponentView>(m_parent)
+        ->GetHwndForParenting();
+  }
+
+  // Fallback if we do not know any more specific HWND
+  return reinterpret_cast<HWND>(winrt::Microsoft::ReactNative::implementation::ReactCoreInjection::GetTopLevelWindowId(
+      m_reactContext.Properties().Handle()));
+}
+
 winrt::Microsoft::ReactNative::Composition::implementation::RootComponentView *ComponentView::rootComponentView()
     const noexcept {
   if (m_rootView)

diff --git a/vnext/Microsoft.ReactNative/Fabric/ComponentView.h b/vnext/Microsoft.ReactNative/Fabric/ComponentView.h
@@ -209,6 +209,9 @@ struct ComponentView : public ComponentViewT<ComponentView> {
   // Notify up the tree to bring the rect into view by scrolling as needed
   virtual void StartBringIntoView(BringIntoViewOptions &&args) noexcept;
 
+  // Eventually PopupContentLink and similar APIs will remove the need for this.
+  virtual HWND GetHwndForParenting() noexcept;
+
   virtual const winrt::Microsoft::ReactNative::IComponentProps userProps(
       facebook::react::Props::Shared const &props) noexcept;
 

diff --git a/vnext/Microsoft.ReactNative/Fabric/Composition/CompositionViewComponentView.cpp b/vnext/Microsoft.ReactNative/Fabric/Composition/CompositionViewComponentView.cpp
@@ -23,6 +23,7 @@
 #include "CompositionHelpers.h"
 #include "RootComponentView.h"
 #include "Theme.h"
+#include "TooltipService.h"
 #include "UiaHelpers.h"
 #include "d2d1helper.h"
 
@@ -43,6 +44,13 @@ ComponentView::ComponentView(
   m_outerVisual.InsertAt(m_focusVisual.InnerVisual(), 0);
 }
 
+ComponentView::~ComponentView() {
+  if (m_tooltipTracked) {
+    TooltipService::GetCurrent(m_reactContext.Properties())->StopTracking(*this);
+    m_tooltipTracked = false;
+  }
+}
+
 facebook::react::Tag ComponentView::Tag() const noexcept {
   return m_tag;
 }
@@ -130,6 +138,16 @@ void ComponentView::updateProps(
     updateShadowProps(oldViewProps, newViewProps);
   }
 
+  if (oldViewProps.tooltip != newViewProps.tooltip) {
+    if (!m_tooltipTracked && newViewProps.tooltip) {
+      TooltipService::GetCurrent(m_reactContext.Properties())->StartTracking(*this);
+      m_tooltipTracked = true;
+    } else if (m_tooltipTracked && !newViewProps.tooltip) {
+      TooltipService::GetCurrent(m_reactContext.Properties())->StopTracking(*this);
+      m_tooltipTracked = false;
+    }
+  }
+
   base_type::updateProps(props, oldProps);
 }
 

diff --git a/vnext/Microsoft.ReactNative/Fabric/Composition/CompositionViewComponentView.h b/vnext/Microsoft.ReactNative/Fabric/Composition/CompositionViewComponentView.h
@@ -30,6 +30,7 @@ struct ComponentView : public ComponentViewT<
       facebook::react::Tag tag,
       winrt::Microsoft::ReactNative::ReactContext const &reactContext,
       ComponentViewFeatures flags);
+  virtual ~ComponentView();
 
   virtual winrt::Microsoft::ReactNative::Composition::Experimental::IVisual Visual() const noexcept {
     return nullptr;
@@ -151,6 +152,7 @@ struct ComponentView : public ComponentViewT<
       const facebook::react::ViewProps &viewProps) noexcept;
 
   bool m_FinalizeTransform{false};
+  bool m_tooltipTracked{false};
   ComponentViewFeatures m_flags;
   void showFocusVisual(bool show) noexcept;
   winrt::Microsoft::ReactNative::Composition::Experimental::IFocusVisual m_focusVisual{nullptr};

diff --git a/vnext/Microsoft.ReactNative/Fabric/Composition/ReactNativeIsland.cpp b/vnext/Microsoft.ReactNative/Fabric/Composition/ReactNativeIsland.cpp
@@ -333,7 +333,7 @@ winrt::IInspectable ReactNativeIsland::GetUiaProvider() noexcept {
   if (m_uiaProvider == nullptr) {
     m_uiaProvider =
         winrt::make<winrt::Microsoft::ReactNative::implementation::CompositionRootAutomationProvider>(*this);
-    if (m_hwnd) {
+    if (m_hwnd && !m_island) {
       auto pRootProvider =
           static_cast<winrt::Microsoft::ReactNative::implementation::CompositionRootAutomationProvider *>(
               m_uiaProvider.as<IRawElementProviderSimple>().get());
@@ -349,6 +349,10 @@ void ReactNativeIsland::SetWindow(uint64_t hwnd) noexcept {
   m_hwnd = reinterpret_cast<HWND>(hwnd);
 }
 
+HWND ReactNativeIsland::GetHwndForParenting() noexcept {
+  return m_hwnd;
+}
+
 int64_t ReactNativeIsland::SendMessage(uint32_t msg, uint64_t wParam, int64_t lParam) noexcept {
   if (m_rootTag == -1)
     return 0;
@@ -368,7 +372,7 @@ int64_t ReactNativeIsland::SendMessage(uint32_t msg, uint64_t wParam, int64_t lP
 bool ReactNativeIsland::CapturePointer(
     const winrt::Microsoft::ReactNative::Composition::Input::Pointer &pointer,
     facebook::react::Tag tag) noexcept {
-  if (m_hwnd) {
+  if (m_hwnd && !m_island) {
     SetCapture(m_hwnd);
   }
   return m_CompositionEventHandler->CapturePointer(pointer, tag);
@@ -378,7 +382,7 @@ void ReactNativeIsland::ReleasePointerCapture(
     const winrt::Microsoft::ReactNative::Composition::Input::Pointer &pointer,
     facebook::react::Tag tag) noexcept {
   if (m_CompositionEventHandler->ReleasePointerCapture(pointer, tag)) {
-    if (m_hwnd) {
+    if (m_hwnd && !m_island) {
       if (m_hwnd == GetCapture()) {
         ReleaseCapture();
       }

diff --git a/vnext/Microsoft.ReactNative/Fabric/Composition/ReactNativeIsland.h b/vnext/Microsoft.ReactNative/Fabric/Composition/ReactNativeIsland.h
@@ -82,6 +82,7 @@ struct ReactNativeIsland
   void AddRenderedVisual(const winrt::Microsoft::ReactNative::Composition::Experimental::IVisual &visual) noexcept;
   void RemoveRenderedVisual(const winrt::Microsoft::ReactNative::Composition::Experimental::IVisual &visual) noexcept;
   bool TrySetFocus() noexcept;
+  HWND GetHwndForParenting() noexcept;
 
   winrt::Microsoft::ReactNative::Composition::ICustomResourceLoader Resources() noexcept;
   void Resources(const winrt::Microsoft::ReactNative::Composition::ICustomResourceLoader &resources) noexcept;

diff --git a/vnext/Microsoft.ReactNative/Fabric/Composition/RootComponentView.cpp b/vnext/Microsoft.ReactNative/Fabric/Composition/RootComponentView.cpp
@@ -231,4 +231,15 @@ winrt::Microsoft::ReactNative::implementation::ClipState RootComponentView::getC
   return winrt::Microsoft::ReactNative::implementation::ClipState::NoClip;
 }
 
+HWND RootComponentView::GetHwndForParenting() noexcept {
+  if (auto rootView = m_wkRootView.get()) {
+    auto hwnd = winrt::get_self<winrt::Microsoft::ReactNative::implementation::ReactNativeIsland>(rootView)
+                    ->GetHwndForParenting();
+    if (hwnd)
+      return hwnd;
+  }
+
+  return base_type::GetHwndForParenting();
+}
+
 } // namespace winrt::Microsoft::ReactNative::Composition::implementation
diff --git a/vnext/Microsoft.ReactNative/Fabric/Composition/RootComponentView.h b/vnext/Microsoft.ReactNative/Fabric/Composition/RootComponentView.h
@@ -64,6 +64,8 @@ struct RootComponentView : RootComponentViewT<RootComponentView, ViewComponentVi
   winrt::Microsoft::ReactNative::ComponentView FindFirstFocusableElement() noexcept;
   winrt::Microsoft::ReactNative::ComponentView FindLastFocusableElement() noexcept;
 
+  HWND GetHwndForParenting() noexcept override;
+
  private:
   // should this be a ReactTaggedView? - It shouldn't actually matter since if the view is going away it should always
   // be clearing its focus But being a reactTaggedView might make it easier to identify cases where that isn't

diff --git a/vnext/Microsoft.ReactNative/Fabric/Composition/TextDrawing.cpp b/vnext/Microsoft.ReactNative/Fabric/Composition/TextDrawing.cpp
@@ -16,7 +16,7 @@
 namespace winrt::Microsoft::ReactNative::Composition {
 
 void RenderText(
-    ID2D1DeviceContext &deviceContext,
+    ID2D1RenderTarget &deviceContext,
     ::IDWriteTextLayout &textLayout,
     const facebook::react::AttributedString &attributedString,
     const facebook::react::TextAttributes &textAttributes,
@@ -26,7 +26,6 @@ void RenderText(
   float offsetX = offset.x / pointScaleFactor;
   float offsetY = offset.y / pointScaleFactor;
 
-  assert(deviceContext.GetUnitMode() == D2D1_UNIT_MODE_DIPS);
   const auto dpi = pointScaleFactor * 96.0f;
   float oldDpiX, oldDpiY;
   deviceContext.GetDpi(&oldDpiX, &oldDpiY);

diff --git a/vnext/Microsoft.ReactNative/Fabric/Composition/TextDrawing.h b/vnext/Microsoft.ReactNative/Fabric/Composition/TextDrawing.h
@@ -14,7 +14,7 @@
 namespace winrt::Microsoft::ReactNative::Composition {
 
 void RenderText(
-    ID2D1DeviceContext &deviceContext,
+    ID2D1RenderTarget &deviceContext,
     ::IDWriteTextLayout &textLayout,
     const facebook::react::AttributedString &attributedString,
     const facebook::react::TextAttributes &textAttributes,

diff --git a/vnext/Microsoft.ReactNative/Fabric/Composition/Theme.cpp b/vnext/Microsoft.ReactNative/Fabric/Composition/Theme.cpp
@@ -296,7 +296,9 @@ bool Theme::TryGetPlatformColor(const std::string &platformColor, winrt::Windows
           {"ScrollBarThumbFillDisabled", "ControlStrongFillColorDisabled"},
           {"ScrollBarTrackFill",
            "AcrylicInAppFillColorDefault"}, // TODO make AcrylicInAppFillColorDefault a real acrylic brush
-      };
+          {"ToolTipBackground", "SystemChromeMediumLowColor"},
+          {"ToolTipForeground", "SystemControlForegroundBaseHighColor"},
+          {"ToolTipBorderBrush", "SystemControlTransientBorderColor"}};
 
   static std::unordered_map<std::string, winrt::Windows::UI::Color, std::hash<std::string_view>, std::equal_to<>>
       s_lightColors = {
@@ -326,7 +328,9 @@ bool Theme::TryGetPlatformColor(const std::string &platformColor, winrt::Windows
           {"ControlStrongFillColorDefault", {0x72, 0x00, 0x00, 0x00}},
           {"ControlStrongFillColorDisabled", {0x51, 0x00, 0x00, 0x00}},
           {"AcrylicInAppFillColorDefault", {0x9E, 0xFF, 0xFF, 0xFF}},
-      };
+          {"SystemChromeMediumLowColor", {0xFF, 0xF2, 0xF2, 0xF2}},
+          {"SystemControlForegroundBaseHighColor", {0xFF, 0x00, 0x00, 0x00}},
+          {"SystemControlTransientBorderColor", {0x24, 0x00, 0x00, 0x00}}};
 
   static std::unordered_map<std::string, winrt::Windows::UI::Color, std::hash<std::string_view>, std::equal_to<>>
       s_darkColors = {
@@ -356,7 +360,9 @@ bool Theme::TryGetPlatformColor(const std::string &platformColor, winrt::Windows
           {"ControlStrongFillColorDefault", {0x8B, 0xFF, 0xFF, 0xFF}},
           {"ControlStrongFillColorDisabled", {0x3F, 0xFF, 0xFF, 0xFF}},
           {"AcrylicInAppFillColorDefault", {0x9E, 0x00, 0x00, 0x00}},
-      };
+          {"SystemChromeMediumLowColor", {0xFF, 0x2B, 0x2B, 0x2B}},
+          {"SystemControlForegroundBaseHighColor", {0xFF, 0xFF, 0xFF, 0xFF}},
+          {"SystemControlTransientBorderColor", {0x5C, 0x00, 0x00, 0x00}}};
 
   static std::unordered_map<
       std::string,
@@ -391,7 +397,9 @@ bool Theme::TryGetPlatformColor(const std::string &platformColor, winrt::Windows
           {"SubtleFillColorSecondary", {winrt::Windows::UI::ViewManagement::UIElementType::ButtonFace, {}}},
           {"ControlStrongFillColorDefault", {winrt::Windows::UI::ViewManagement::UIElementType::ButtonFace, {}}},
           {"ControlStrongFillColorDisabled", {winrt::Windows::UI::ViewManagement::UIElementType::ButtonFace, {}}},
-      };
+          {"SystemChromeMediumLowColor", {winrt::Windows::UI::ViewManagement::UIElementType::ButtonFace, {}}},
+          {"SystemControlForegroundBaseHighColor", {winrt::Windows::UI::ViewManagement::UIElementType::ButtonText, {}}},
+          {"SystemControlTransientBorderColor", {winrt::Windows::UI::ViewManagement::UIElementType::ButtonText, {}}}};
 
   auto alias = s_xamlAliasedColors.find(platformColor);
   if (alias != s_xamlAliasedColors.end()) {