NavigationView not updating UIA users about changed selection and expand state

dev/Generated/NavigationViewItem.properties.cpp

@@ -83,7 +83,7 @@ void NavigationViewItemProperties::EnsureProperties()
                 winrt::name_of<winrt::NavigationViewItem>(),
                 false /* isAttached */,
                 ValueHelper<bool>::BoxValueIfNecessary(false),
-                nullptr);
+                winrt::PropertyChangedCallback(&OnIsExpandedPropertyChanged));
     }
     if (!s_MenuItemsProperty)
     {
@@ -149,6 +149,14 @@ void NavigationViewItemProperties::OnIconPropertyChanged(
     winrt::get_self<NavigationViewItem>(owner)->OnIconPropertyChanged(args);
 }
 
+void NavigationViewItemProperties::OnIsExpandedPropertyChanged(
+    winrt::DependencyObject const& sender,
+    winrt::DependencyPropertyChangedEventArgs const& args)
+{
+    auto owner = sender.as<winrt::NavigationViewItem>();
+    winrt::get_self<NavigationViewItem>(owner)->OnIsExpandedPropertyChanged(args);
+}
+
 void NavigationViewItemProperties::OnMenuItemsPropertyChanged(
     winrt::DependencyObject const& sender,
     winrt::DependencyPropertyChangedEventArgs const& args)

dev/Generated/NavigationViewItem.properties.h

@@ -62,6 +62,10 @@ class NavigationViewItemProperties
         winrt::DependencyObject const& sender,
         winrt::DependencyPropertyChangedEventArgs const& args);
 
+    static void OnIsExpandedPropertyChanged(
+        winrt::DependencyObject const& sender,
+        winrt::DependencyPropertyChangedEventArgs const& args);
+
     static void OnMenuItemsPropertyChanged(
         winrt::DependencyObject const& sender,
         winrt::DependencyPropertyChangedEventArgs const& args);

dev/NavigationView/NavigationView.cpp

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 #include "pch.h"
@@ -742,6 +742,12 @@ void NavigationView::OnNavigationViewItemInvoked(const winrt::NavigationViewItem
     if (updateSelection)
     {
         auto ip = GetIndexPathForContainer(nvi);
+
+        // Determine if we will update collapse/expand which will happen on iff the item has children
+        if (DoesNavigationViewItemHaveChildren(nvi))
+        {
+            m_shouldIgnoreUIASelectionRaiseAsExpandCollapseWillRaise = true;
+        }
         UpdateSelectionModelSelection(ip);
     }
 
@@ -1930,13 +1936,32 @@ void NavigationView::ChangeSelection(const winrt::IInspectable& prevItem, const
         UnselectPrevItem(prevItem, nextItem);
         ChangeSelectStatusForItem(nextItem, true /*selected*/);
 
+        // Selection changed and we need to notify UIA
+        // HOWEVER expand collapse can also trigger if an item can expand/collapse
+        // There are multiple cases when selectino changes:
+        // - Through click on item with no children -> No expand/collapse change
+        // - Through click on item with children -> Expand/collapse change
+        // - Through API with item without children -> No expand/collapse change
+        // - Through API with item with children -> No expand/collapse change
+        if (!m_shouldIgnoreUIASelectionRaiseAsExpandCollapseWillRaise)
+        {
+            if (winrt::AutomationPeer peer = winrt::FrameworkElementAutomationPeer::FromElement(*this))
+            {
+                auto navViewItemPeer = peer.as<winrt::NavigationViewAutomationPeer>();
+                winrt::get_self<NavigationViewAutomationPeer>(navViewItemPeer)->RaiseSelectionChangedEvent(
+                    prevItem, nextItem
+                );
+            }
+        }
+        m_shouldIgnoreUIASelectionRaiseAsExpandCollapseWillRaise = false;
+
         RaiseSelectionChangedEvent(nextItem, isSettingsItem, recommendedDirection);
         AnimateSelectionChanged(nextItem);
 
         if (auto const nvi = NavigationViewItemOrSettingsContentFromData(nextItem))
         {
             ClosePaneIfNeccessaryAfterItemIsClicked(nvi);
-        }    
+        }
     }
 }
 

dev/NavigationView/NavigationView.h

@@ -441,5 +441,7 @@ class NavigationView :
     bool m_isOpenPaneForInteraction{ false };
 
     bool m_moveTopNavOverflowItemOnFlyoutClose{ false };
+
+    bool m_shouldIgnoreUIASelectionRaiseAsExpandCollapseWillRaise{ false };
 };
 

dev/NavigationView/NavigationView.idl

@@ -342,6 +342,7 @@ unsealed runtimeclass NavigationViewItem : NavigationViewItemBase
     [WUXC_VERSION_MUXONLY]
     {
         [MUX_DEFAULT_VALUE("false")]
+        [MUX_PROPERTY_CHANGED_CALLBACK(TRUE)]
         Boolean IsExpanded{ get; set; };
         [MUX_PROPERTY_CHANGED_CALLBACK(TRUE)]
         [MUX_DEFAULT_VALUE("false")]

dev/NavigationView/NavigationViewAutomationPeer.cpp

@@ -50,3 +50,20 @@ winrt::com_array<winrt::Windows::UI::Xaml::Automation::Provider::IRawElementProv
     }
     return {};
 }
+
+void NavigationViewAutomationPeer::RaiseSelectionChangedEvent(winrt::IInspectable const& oldSelection, winrt::IInspectable const& newSelecttion)
+{
+    if (winrt::AutomationPeer::ListenerExists(winrt::AutomationEvents::SelectionPatternOnInvalidated))
+    {
+        if (auto nv = Owner().try_as<winrt::NavigationView>())
+        {
+            if (auto nvi = winrt::get_self<NavigationView>(nv)->GetSelectedContainer())
+            {
+                if (auto peer = winrt::FrameworkElementAutomationPeer::CreatePeerForElement(nvi))
+                {
+                    peer.RaiseAutomationEvent(winrt::AutomationEvents::SelectionItemPatternOnElementSelected);
+                }
+            }
+        }
+    }
+}

dev/NavigationView/NavigationViewAutomationPeer.h

@@ -23,5 +23,7 @@ class NavigationViewAutomationPeer :
     bool IsSelectionRequired();
     winrt::com_array<winrt::Windows::UI::Xaml::Automation::Provider::IRawElementProviderSimple> GetSelection();
 
+    void RaiseSelectionChangedEvent(winrt::IInspectable const& oldSelection, winrt::IInspectable const& newSelecttion);
+
 private:
 };

dev/NavigationView/NavigationViewItem.cpp

@@ -247,6 +247,19 @@ void NavigationViewItem::SuggestedToolTipChanged(winrt::IInspectable const& newC
     m_suggestedToolTipContent.set(newToolTipContent);
 }
 
+void NavigationViewItem::OnIsExpandedPropertyChanged(const winrt::DependencyPropertyChangedEventArgs& args)
+{
+    if (winrt::AutomationPeer peer = winrt::FrameworkElementAutomationPeer::FromElement(*this))
+    {
+        auto navViewItemPeer = peer.as<winrt::NavigationViewItemAutomationPeer>();
+        winrt::get_self<NavigationViewItemAutomationPeer>(navViewItemPeer)->RaiseExpandCollapseAutomationEvent(
+            IsExpanded() ?
+                winrt::ExpandCollapseState::Expanded :
+                winrt::ExpandCollapseState::Collapsed
+        );
+    }
+}
+
 void NavigationViewItem::OnIconPropertyChanged(const winrt::DependencyPropertyChangedEventArgs& args)
 {
     UpdateVisualStateNoTransition();

dev/NavigationView/NavigationViewItem.h

@@ -27,6 +27,7 @@ class NavigationViewItem :
     void OnApplyTemplate() override;
 
     // Property change callbacks
+    void OnIsExpandedPropertyChanged(const winrt::DependencyPropertyChangedEventArgs& args);
     void OnIconPropertyChanged(const winrt::DependencyPropertyChangedEventArgs& args);
     void OnMenuItemsPropertyChanged(const winrt::DependencyPropertyChangedEventArgs& args);
     void OnMenuItemsSourcePropertyChanged(const winrt::DependencyPropertyChangedEventArgs& args);