[Fabric] Add Support for the IToggleProvider (#13622)

chiaramooney · web-flow · commit 8c60ffef9c4a · 2024-09-05T10:40:12.000-07:00
* Add Support for Toggle Provider

* Refactor Dump Alg

* Change files

* Format

* Fix Merge Error

* Fix Merge Error
diff --git a/change/react-native-windows-a5988a0a-5c91-4849-8751-5264d7e94249.json b/change/react-native-windows-a5988a0a-5c91-4849-8751-5264d7e94249.json
@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "Add Support for Toggle Provider",
+  "packageName": "react-native-windows",
+  "email": "34109996+chiaramooney@users.noreply.github.com",
+  "dependentChangeType": "patch"
+}
diff --git a/packages/e2e-test-app-fabric/test/__snapshots__/SwitchComponentTest.test.ts.snap b/packages/e2e-test-app-fabric/test/__snapshots__/SwitchComponentTest.test.ts.snap
@@ -44,6 +44,7 @@ exports[`SwitchTests Change events can be detected, event regression top 1`] = `
     "ControlType": 50000,
     "IsKeyboardFocusable": true,
     "LocalizedControlType": "button",
+    "TogglePattern.ToggleState": "On",
   },
   "Component Tree": {
     "Type": "Microsoft.ReactNative.Composition.SwitchComponentView",
@@ -118,6 +119,7 @@ exports[`SwitchTests Change events can be detected, events regression bottom 1`]
     "ControlType": 50000,
     "IsKeyboardFocusable": true,
     "LocalizedControlType": "button",
+    "TogglePattern.ToggleState": "On",
   },
   "Component Tree": {
     "Type": "Microsoft.ReactNative.Composition.SwitchComponentView",
@@ -229,6 +231,7 @@ exports[`SwitchTests Custom colors can be provided, initial true 1`] = `
     "ControlType": 50000,
     "IsKeyboardFocusable": true,
     "LocalizedControlType": "button",
+    "TogglePattern.ToggleState": "On",
   },
   "Component Tree": {
     "Type": "Microsoft.ReactNative.Composition.SwitchComponentView",
@@ -303,6 +306,7 @@ exports[`SwitchTests Switches can be disabled, initial true 1`] = `
     "ControlType": 50000,
     "IsKeyboardFocusable": true,
     "LocalizedControlType": "button",
+    "TogglePattern.ToggleState": "On",
   },
   "Component Tree": {
     "Type": "Microsoft.ReactNative.Composition.SwitchComponentView",
@@ -377,6 +381,7 @@ exports[`SwitchTests Switches can be set to true/false, initial true 1`] = `
     "ControlType": 50000,
     "IsKeyboardFocusable": true,
     "LocalizedControlType": "button",
+    "TogglePattern.ToggleState": "On",
   },
   "Component Tree": {
     "Type": "Microsoft.ReactNative.Composition.SwitchComponentView",
@@ -423,6 +428,7 @@ exports[`SwitchTests Switches can have customized accessibility 1`] = `
         "Name": "This is a Switch",
         "PositionInSet": 1,
         "SizeofSet": 4,
+        "TogglePattern.ToggleState": "On",
       },
       {
         "AutomationId": "",
@@ -433,6 +439,7 @@ exports[`SwitchTests Switches can have customized accessibility 1`] = `
         "Name": "This is a Switch with focusable set to false",
         "PositionInSet": 2,
         "SizeofSet": 4,
+        "TogglePattern.ToggleState": "On",
       },
       {
         "AutomationId": "",
@@ -455,6 +462,7 @@ exports[`SwitchTests Switches can have customized accessibility 1`] = `
         "Name": "This is a Switch with focusable and accessible set to false",
         "PositionInSet": 4,
         "SizeofSet": 4,
+        "TogglePattern.ToggleState": "On",
       },
     ],
   },
diff --git a/packages/e2e-test-app-fabric/windows/RNTesterApp-Fabric/RNTesterApp-Fabric.cpp b/packages/e2e-test-app-fabric/windows/RNTesterApp-Fabric/RNTesterApp-Fabric.cpp
@@ -293,6 +293,26 @@ void InsertFloat3Value(
   obj.Insert(name, winrt::Windows::Data::Json::JsonValue::CreateStringValue(str));
 }
 
+void InsertToggleStateValueIfNotDefault(
+    const winrt::Windows::Data::Json::JsonObject &obj,
+    winrt::hstring name,
+    ToggleState value,
+    ToggleState defaultValue = ToggleState::ToggleState_Off) {
+  if (value != defaultValue) {
+    switch (value) {
+      case 0:
+        obj.Insert(name, winrt::Windows::Data::Json::JsonValue::CreateStringValue(L"Off"));
+        break;
+      case 1:
+        obj.Insert(name, winrt::Windows::Data::Json::JsonValue::CreateStringValue(L"On"));
+        break;
+      case 2:
+        obj.Insert(name, winrt::Windows::Data::Json::JsonValue::CreateStringValue(L"Indeterminate"));
+        break;
+    }
+  }
+}
+
 winrt::Windows::Data::Json::JsonObject ListErrors(winrt::Windows::Data::Json::JsonValue payload) {
   winrt::Windows::Data::Json::JsonObject result;
   winrt::Windows::Data::Json::JsonArray jsonErrors;
@@ -313,6 +333,39 @@ winrt::Windows::Data::Json::JsonObject ListErrors(winrt::Windows::Data::Json::Js
   return result;
 }
 
+void DumpUIAPatternInfo(IUIAutomationElement *pTarget, const winrt::Windows::Data::Json::JsonObject &result) {
+  BSTR value;
+  BOOL isReadOnly;
+  ToggleState toggleState;
+  IValueProvider *valuePattern;
+  HRESULT hr;
+
+  // Dump IValueProvider Information
+  hr = pTarget->GetCurrentPattern(UIA_ValuePatternId, reinterpret_cast<IUnknown **>(&valuePattern));
+  if (SUCCEEDED(hr) && valuePattern) {
+    hr = valuePattern->get_Value(&value);
+    if (SUCCEEDED(hr)) {
+      InsertStringValueIfNotEmpty(result, L"ValuePattern.Value", value);
+    }
+    hr = valuePattern->get_IsReadOnly(&isReadOnly);
+    if (SUCCEEDED(hr)) {
+      InsertBooleanValueIfNotDefault(result, L"ValuePattern.IsReadOnly", isReadOnly, true);
+    }
+    valuePattern->Release();
+  }
+
+  // Dump IToggleProvider Information
+  IToggleProvider *togglePattern;
+  hr = pTarget->GetCurrentPattern(UIA_TogglePatternId, reinterpret_cast<IUnknown **>(&togglePattern));
+  if (SUCCEEDED(hr) && togglePattern) {
+    hr = togglePattern->get_ToggleState(&toggleState);
+    if (SUCCEEDED(hr)) {
+      InsertToggleStateValueIfNotDefault(result, L"TogglePattern.ToggleState", toggleState);
+    }
+    togglePattern->Release();
+  }
+}
+
 winrt::Windows::Data::Json::JsonObject DumpUIATreeRecurse(
     IUIAutomationElement *pTarget,
     IUIAutomationTreeWalker *pWalker) {
@@ -326,8 +379,6 @@ winrt::Windows::Data::Json::JsonObject DumpUIATreeRecurse(
   BSTR name;
   int positionInSet = 0;
   int sizeOfSet = 0;
-  BSTR value;
-  BOOL isReadOnly;
   LiveSetting liveSetting = LiveSetting::Off;
 
   pTarget->get_CurrentAutomationId(&automationId);
@@ -356,20 +407,8 @@ winrt::Windows::Data::Json::JsonObject DumpUIATreeRecurse(
   InsertIntValueIfNotDefault(result, L"PositionInSet", positionInSet);
   InsertIntValueIfNotDefault(result, L"SizeofSet", sizeOfSet);
   InsertLiveSettingValueIfNotDefault(result, L"LiveSetting", liveSetting);
+  DumpUIAPatternInfo(pTarget, result);
 
-  IValueProvider *valuePattern;
-  hr = pTarget->GetCurrentPattern(UIA_ValuePatternId, reinterpret_cast<IUnknown **>(&valuePattern));
-  if (SUCCEEDED(hr) && valuePattern) {
-    hr = valuePattern->get_Value(&value);
-    if (SUCCEEDED(hr)) {
-      InsertStringValueIfNotEmpty(result, L"ValuePattern.Value", value);
-    }
-    hr = valuePattern->get_IsReadOnly(&isReadOnly);
-    if (SUCCEEDED(hr)) {
-      InsertBooleanValueIfNotDefault(result, L"ValuePattern.IsReadOnly", isReadOnly, true);
-    }
-    valuePattern->Release();
-  }
   IUIAutomationElement *pChild;
   IUIAutomationElement *pSibling;
   pWalker->GetFirstChildElement(pTarget, &pChild);
diff --git a/vnext/Microsoft.ReactNative/Fabric/ComponentView.cpp b/vnext/Microsoft.ReactNative/Fabric/ComponentView.cpp
@@ -649,6 +649,14 @@ bool ComponentView::getAcccessiblityIsReadOnly() noexcept {
   return false;
 }
 
+ToggleState ComponentView::getToggleState() noexcept {
+  return ToggleState::ToggleState_Off;
+}
+
+void ComponentView::Toggle() noexcept {
+  assert(false);
+}
+
 // Notify up the tree to bring the rect into view by scrolling as needed
 void ComponentView::StartBringIntoView(BringIntoViewOptions &&args) noexcept {
   assert(false);
diff --git a/vnext/Microsoft.ReactNative/Fabric/ComponentView.h b/vnext/Microsoft.ReactNative/Fabric/ComponentView.h
@@ -12,6 +12,7 @@
 #include <react/renderer/core/LayoutMetrics.h>
 
 #include <Fabric/Composition/Theme.h>
+#include <uiautomationcore.h>
 #include <winrt/Microsoft.ReactNative.Composition.Input.h>
 #include <winrt/Microsoft.ReactNative.h>
 
@@ -200,6 +201,8 @@ struct ComponentView : public ComponentViewT<ComponentView> {
   virtual std::optional<std::string> getAccessiblityValue() noexcept;
   virtual void setAcccessiblityValue(std::string &&value) noexcept;
   virtual bool getAcccessiblityIsReadOnly() noexcept;
+  virtual ToggleState getToggleState() noexcept;
+  virtual void Toggle() noexcept;
   winrt::Microsoft::ReactNative::IReactContext ReactContext() const noexcept;
 
   // Notify up the tree to bring the rect into view by scrolling as needed
diff --git a/vnext/Microsoft.ReactNative/Fabric/Composition/CompositionDynamicAutomationProvider.cpp b/vnext/Microsoft.ReactNative/Fabric/Composition/CompositionDynamicAutomationProvider.cpp
@@ -176,6 +176,11 @@ HRESULT __stdcall CompositionDynamicAutomationProvider::GetPatternProvider(PATTE
     AddRef();
   }
 
+  if (patternId == UIA_TogglePatternId && (accessibilityRole == "switch" || accessibilityRole == "checkbox")) {
+    *pRetVal = static_cast<IToggleProvider *>(this);
+    AddRef();
+  }
+
   return S_OK;
 }
 
@@ -463,4 +468,27 @@ HRESULT __stdcall CompositionDynamicAutomationProvider::get_IsReadOnly(BOOL *pRe
   return S_OK;
 }
 
+HRESULT __stdcall CompositionDynamicAutomationProvider::get_ToggleState(ToggleState *pRetVal) {
+  if (pRetVal == nullptr)
+    return E_POINTER;
+  auto strongView = m_view.view();
+
+  if (!strongView)
+    return UIA_E_ELEMENTNOTAVAILABLE;
+
+  *pRetVal =
+      winrt::get_self<winrt::Microsoft::ReactNative::implementation::ComponentView>(strongView)->getToggleState();
+  return S_OK;
+}
+
+HRESULT __stdcall CompositionDynamicAutomationProvider::Toggle() {
+  auto strongView = m_view.view();
+
+  if (!strongView)
+    return UIA_E_ELEMENTNOTAVAILABLE;
+
+  winrt::get_self<winrt::Microsoft::ReactNative::implementation::ComponentView>(strongView)->Toggle();
+  return S_OK;
+}
+
 } // namespace winrt::Microsoft::ReactNative::implementation
diff --git a/vnext/Microsoft.ReactNative/Fabric/Composition/CompositionDynamicAutomationProvider.h b/vnext/Microsoft.ReactNative/Fabric/Composition/CompositionDynamicAutomationProvider.h
@@ -15,7 +15,8 @@ class CompositionDynamicAutomationProvider : public winrt::implements<
                                                  IRawElementProviderSimple,
                                                  IInvokeProvider,
                                                  IScrollItemProvider,
-                                                 IValueProvider> {
+                                                 IValueProvider,
+                                                 IToggleProvider> {
  public:
   CompositionDynamicAutomationProvider(
       const winrt::Microsoft::ReactNative::Composition::ComponentView &componentView) noexcept;
@@ -46,6 +47,10 @@ class CompositionDynamicAutomationProvider : public winrt::implements<
   virtual HRESULT __stdcall get_Value(BSTR *pRetVal) override;
   virtual HRESULT __stdcall get_IsReadOnly(BOOL *pRetVal) override;
 
+  // inherited via IToggleProivder
+  virtual HRESULT __stdcall get_ToggleState(ToggleState *pRetVal) override;
+  virtual HRESULT __stdcall Toggle() override;
+
  private:
   ::Microsoft::ReactNative::ReactTaggedView m_view;
 };
diff --git a/vnext/Microsoft.ReactNative/Fabric/Composition/CompositionViewComponentView.cpp b/vnext/Microsoft.ReactNative/Fabric/Composition/CompositionViewComponentView.cpp
@@ -1335,6 +1335,14 @@ bool ComponentView::getAcccessiblityIsReadOnly() noexcept {
   return true;
 }
 
+ToggleState ComponentView::getToggleState() noexcept {
+  return ToggleState::ToggleState_Off;
+}
+
+void ComponentView::Toggle() noexcept {
+  // no-op
+}
+
 void ComponentView::updateBorderLayoutMetrics(
     facebook::react::LayoutMetrics const &layoutMetrics,
     const facebook::react::ViewProps &viewProps) noexcept {
diff --git a/vnext/Microsoft.ReactNative/Fabric/Composition/CompositionViewComponentView.h b/vnext/Microsoft.ReactNative/Fabric/Composition/CompositionViewComponentView.h
@@ -95,6 +95,8 @@ struct ComponentView : public ComponentViewT<
   std::optional<std::string> getAccessiblityValue() noexcept override;
   void setAcccessiblityValue(std::string &&value) noexcept override;
   bool getAcccessiblityIsReadOnly() noexcept override;
+  ToggleState getToggleState() noexcept override;
+  void Toggle() noexcept override;
   virtual winrt::Microsoft::ReactNative::implementation::ClipState getClipState() noexcept;
 
   const facebook::react::LayoutMetrics &layoutMetrics() const noexcept;
diff --git a/vnext/Microsoft.ReactNative/Fabric/Composition/SwitchComponentView.cpp b/vnext/Microsoft.ReactNative/Fabric/Composition/SwitchComponentView.cpp
@@ -339,4 +339,18 @@ const facebook::react::SwitchProps &SwitchComponentView::switchProps() const noe
   return *std::static_pointer_cast<const facebook::react::SwitchProps>(viewProps());
 }
 
+// getToggleState method for IToggleProvider
+ToggleState SwitchComponentView::getToggleState() noexcept {
+  if (switchProps().value) {
+    return ToggleState::ToggleState_On;
+  } else {
+    return ToggleState::ToggleState_Off;
+  }
+}
+
+// Toggle method for IToggleProvider
+void SwitchComponentView::Toggle() noexcept {
+  toggle();
+}
+
 } // namespace winrt::Microsoft::ReactNative::Composition::implementation
diff --git a/vnext/Microsoft.ReactNative/Fabric/Composition/SwitchComponentView.h b/vnext/Microsoft.ReactNative/Fabric/Composition/SwitchComponentView.h
@@ -57,6 +57,8 @@ struct SwitchComponentView : SwitchComponentViewT<SwitchComponentView, ViewCompo
 
   static facebook::react::SharedViewProps defaultProps() noexcept;
   const facebook::react::SwitchProps &switchProps() const noexcept;
+  ToggleState getToggleState() noexcept override;
+  void Toggle() noexcept override;
   winrt::Microsoft::ReactNative::Composition::Experimental::IVisual createVisual() noexcept override;
 
  private:
