feat: MenuFlyout support for keyboard accelerators

src/Uno.UI.RuntimeTests/MUX/Input/KeyboardAccelerators/KeyboardAcceleratorTests.cs

@@ -9,13 +9,12 @@
 using Microsoft.UI.Xaml.Controls.Primitives;
 using Microsoft.UI.Xaml.Input;
 using Microsoft.UI.Xaml.Markup;
-using Microsoft.UI.Xaml.Media;
 using Microsoft.UI.Xaml.Tests.Common;
 using MUXControlsTestApp.Utilities;
 using Private.Infrastructure;
 using Windows.System;
-using MenuBarItem = Microsoft/* UWP don't rename */.UI.Xaml.Controls.MenuBarItem;
 using FocusHelper = Uno.UI.RuntimeTests.MUX.Input.Focus.FocusHelper;
+using MenuBarItem = Microsoft/* UWP don't rename */.UI.Xaml.Controls.MenuBarItem;
 
 #if !HAS_UNO_WINUI
 using Microsoft/* UWP don't rename */.UI.Xaml.Tests.Common;
@@ -1437,7 +1436,6 @@ await TestServices.RunOnUIThread(() =>
 
 	[TestMethod]
 	[TestProperty("Description", "Validates that Button control fires the accelerators on its attached MenuFlyout.")]
-	[Ignore("Requires MenuFlyout support for Keyboard Accelerators #17133")]
 	public async Task VerifyButtonFlyoutWithMenuFlyoutCanInvokeAcceleratorDefinedOnMenuItem()
 	{
 		const string rootPanelXaml =
@@ -1501,7 +1499,6 @@ await TestServices.RunOnUIThread(async () =>
 
 	[TestMethod]
 	[TestProperty("Description", "Verify accelerators submenuitem in menuflyout on button control.")]
-	[Ignore("Requires MenuFlyout support for Keyboard Accelerators #17133")]
 	public async Task VerifyAcceleratorsDefinedOnSubMenuItemInMenuFlyoutOnButton()
 	{
 		const string rootPanelXaml =
@@ -1547,8 +1544,10 @@ await TestServices.RunOnUIThread(async () =>
 
 			ButtonWithFlyout = (Button)rootPanel.FindName("ButtonWithFlyout");
 			MenuItem_KA = ((MenuFlyoutItem)rootPanel.FindName("MenuItem")).KeyboardAccelerators[0];
-			Sub_MenuItem_KA = ((MenuFlyoutItem)rootPanel.FindName("Sub_MenuItem_KA")).KeyboardAccelerators[0];
-			Sub_Sub_MenuItem_KA = ((MenuFlyoutItem)rootPanel.FindName("Sub_Sub_MenuItem_KA")).KeyboardAccelerators[0];
+			var menuFlyout = (ButtonWithFlyout.Flyout as MenuFlyout);
+			var rootSubItem = (MenuFlyoutSubItem)menuFlyout.Items[1];
+			Sub_MenuItem_KA = ((MenuFlyoutItem)rootSubItem.Items[1]).KeyboardAccelerators[0];
+			Sub_Sub_MenuItem_KA = ((MenuFlyoutItem)((MenuFlyoutSubItem)rootSubItem.Items[0]).Items[0]).KeyboardAccelerators[0];
 		});
 		await TestServices.WindowHelper.WaitForIdle();
 
@@ -1578,7 +1577,6 @@ await TestServices.RunOnUIThread(async () =>
 
 	[TestMethod]
 	[TestProperty("Description", "Verify accelerators submenuitem in menuflyout on menubar control.")]
-	[Ignore("Requires MenuFlyout support for Keyboard Accelerators #17133")]
 	public async Task VerifyAcceleratorsDefinedOnSubMenuItemInMenuFlyoutOnMenuBar()
 	{
 		const string rootPanelXaml =
@@ -1624,8 +1622,11 @@ await TestServices.RunOnUIThread(async () =>
 
 			ButtonWithoutFlyout = (Button)rootPanel.FindName("ButtonWithoutFlyout");
 			MenuItem_KA = ((MenuFlyoutItem)rootPanel.FindName("MenuItem")).KeyboardAccelerators[0];
-			Sub_MenuItem_KA = ((MenuFlyoutItem)rootPanel.FindName("Sub_MenuItem_KA")).KeyboardAccelerators[0];
-			Sub_Sub_MenuItem_KA = ((MenuFlyoutItem)rootPanel.FindName("Sub_Sub_MenuItem_KA")).KeyboardAccelerators[0];
+			var menuBar = (MenuBar)rootPanel.Children[0];
+			var mainItem = menuBar.Items[0];
+			var rootSubItem = (MenuFlyoutSubItem)mainItem.Items[1];
+			Sub_MenuItem_KA = ((MenuFlyoutItem)rootSubItem.Items[1]).KeyboardAccelerators[0];
+			Sub_Sub_MenuItem_KA = ((MenuFlyoutItem)((MenuFlyoutSubItem)rootSubItem.Items[0]).Items[0]).KeyboardAccelerators[0];
 		});
 		await TestServices.WindowHelper.WaitForIdle();
 
@@ -1655,7 +1656,6 @@ await TestServices.RunOnUIThread(async () =>
 
 	[TestMethod]
 	[TestProperty("Description", "Validates that accelerators on MenuBar works when menu item is collapsed.")]
-	[Ignore("Requires MenuFlyout support for Keyboard Accelerators #17133")]
 	public async Task VerifyAcceleratorDefinedOnMenuBarMenuItems()
 	{
 		const string rootPanelXaml =
@@ -1715,7 +1715,6 @@ await TestServices.RunOnUIThread(async () =>
 
 	[TestMethod]
 	[TestProperty("Description", "Validates that accelerators on MenuBar works when menu item is opened up.")]
-	[Ignore("Requires MenuFlyout support for Keyboard Accelerators #17133")]
 	public async Task VerifyAcceleratorDefinedOnMenuBarMenuItemsWhenItsOpened()
 	{
 		const string rootPanelXaml =
@@ -1781,7 +1780,6 @@ await TestServices.RunOnUIThread(async () =>
 
 	[TestMethod]
 	[TestProperty("Description", "Validates that accelerators on MenuBar works after menu item is opened up and closed again.")]
-	[Ignore("Requires MenuFlyout support for Keyboard Accelerators #17133")]
 	public async Task VerifyAcceleratorDefinedOnMenuBarMenuItemsWhenItsOpenedAndClosed()
 	{
 		const string rootPanelXaml =
@@ -1850,7 +1848,6 @@ await TestServices.RunOnUIThread(async () =>
 
 	[TestMethod]
 	[TestProperty("Description", "Validates that StandardUICommands defined on MenuBar after setting window content, works when menu item is collapsed.")]
-	[Ignore("Requires MenuFlyout support for Keyboard Accelerators #17133")]
 	public async Task VerifyStandarUICommandsDefinedOnMenuBarMenuItemsAfterSettingWindowContent()
 	{
 		const string rootPanelXaml =
@@ -1901,7 +1898,6 @@ await TestServices.RunOnUIThread(() =>
 
 	[TestMethod]
 	[TestProperty("Description", "Validates that StandardUICommands on MenuBar works when menu item closed.")]
-	[Ignore("Requires MenuFlyout support for Keyboard Accelerators #17133")]
 	public async Task VerifyStandarUICommandsDefinedOnMenuBarMenuItems()
 	{
 		const string rootPanelXaml =
@@ -1949,7 +1945,6 @@ await TestServices.RunOnUIThread(async () =>
 
 	[TestMethod]
 	[TestProperty("Description", "Validates that StandarUICommands on MenuBar works when menu item is opened up.")]
-	[Ignore("Requires MenuFlyout support for Keyboard Accelerators #17133")]
 	public async Task VerifyStandarUICommandsDefinedOnMenuBarMenuItemsWhenItsOpened()
 	{
 		const string rootPanelXaml =
@@ -2003,7 +1998,6 @@ await TestServices.RunOnUIThread(async () =>
 
 	[TestMethod]
 	[TestProperty("Description", "Validates that StandarUICommands on MenuBar works after menu item opened up and closed again.")]
-	[Ignore("Requires MenuFlyout support for Keyboard Accelerators #17133")]
 	public async Task VerifyStandarUICommandsDefinedOnMenuBarMenuItemsWhenItsOpenedAndClosed()
 	{
 		const string rootPanelXaml =
@@ -2202,9 +2196,11 @@ await TestServices.RunOnUIThread(async () =>
 			TestServices.WindowHelper.WindowContent = rootPanel;
 			await TestServices.WindowHelper.WaitForLoaded(rootPanel);
 
-			ButtonFlyout = (Flyout)rootPanel.FindName("ButtonFlyout");
-			flyoutButton1 = (Button)rootPanel.FindName("flyoutButton1");
-			flyoutButton2 = (Button)rootPanel.FindName("flyoutButton2");
+			var button1 = (Button)rootPanel.FindName("focusButton1");
+			ButtonFlyout = (Flyout)button1.ContextFlyout;
+			var stackPanel = (StackPanel)ButtonFlyout.Content;
+			flyoutButton1 = (Button)stackPanel.Children[0];
+			flyoutButton2 = (Button)stackPanel.Children[1];
 			focusButton = (Button)rootPanel.FindName("focusButton");
 			ctrl1Accelerator = flyoutButton1.KeyboardAccelerators[0];
 			ctrl1Accelerator.ScopeOwner = ButtonFlyout;
@@ -2289,7 +2285,6 @@ await TestServices.RunOnUIThread(async () =>
 
 	[TestMethod]
 	[TestProperty("Description", "Validates that Button control fires the global accelerators on its attached MenuFlyout.")]
-	[Ignore("Requires MenuFlyout and ContextFlyout support for Keyboard Accelerators #17133 and #17134")]
 	public async Task VerifyButtonContextFlyoutWithMenuFlyoutCanInvokeAcceleratorDefinedOnMenuFlyout()
 	{
 		const string rootPanelXaml =
@@ -2831,7 +2826,6 @@ await TestServices.RunOnUIThread(async () =>
 
 	[TestMethod]
 	[TestProperty("Description", "Validates that ListView fires the accelerators on its attached ContextFlyout.")]
-	[Ignore("Requires ContextFlyout support for Keyboard Accelerators #17134")]
 	public async Task VerifyListViewContextFlyoutCanInvokeHiddenAccelerator()
 	{
 		const string rootPanelXaml =
@@ -3084,7 +3078,6 @@ await TestServices.RunOnUIThread(() =>
 
 	[TestMethod]
 	[TestProperty("Description", "Validates that ListView does not fire the accelerators on its attached ContextFlyout, as it is scoped to be local.")]
-	[Ignore("Requires ContextFlyout support for Keyboard Accelerators #17134")]
 	public async Task VerifyListViewContextFlyoutCanNotInvokeHiddenLocallyScopedAccelerator()
 	{
 		const string rootPanelXaml =

src/Uno.UI.RuntimeTests/Tests/Windows_UI_Xaml_Controls/Given_MenuFlyout.cs

@@ -319,7 +319,7 @@ public async Task When_MenuFlyoutItem_CommandChanging()
 
 			await WindowHelper.WaitForLoaded(flyoutItem);
 
-			flyoutItem.InvokeClick();
+			flyoutItem.Invoke();
 
 			// Force close the flyout as InvokeClick does not do so.
 			item.CloseMenuFlyout();
@@ -330,7 +330,7 @@ public async Task When_MenuFlyoutItem_CommandChanging()
 
 			Assert.IsFalse(flyoutItem.IsEnabled);
 
-			flyoutItem.InvokeClick();
+			flyoutItem.Invoke();
 			item.CloseMenuFlyout();
 		}
 

src/Uno.UI/DirectUI/DXamlCore.cs

@@ -6,13 +6,12 @@
 
 using System;
 using System.Collections.Generic;
+using Microsoft.UI.Xaml.Controls;
 using Uno.UI.Helpers.WinUI;
 using Uno.UI.Xaml.Controls;
 using Uno.UI.Xaml.Core;
-using Windows.ApplicationModel.Resources;
-using Windows.Foundation;
-using Microsoft.UI.Xaml.Controls;
 using Uno.UI.Xaml.Core.Scaling;
+using Windows.Foundation;
 
 namespace DirectUI
 {
@@ -98,5 +97,14 @@ internal void OnCompositionContentStateChangedForUWP()
 			// TODO Uno: Not needed now.
 			// OnUWPWindowSizeChanged();
 		}
+
+		internal bool IsKeyboardPresent
+		{
+			get
+			{
+				// TODO:MZ: Detect HW keyboard where possible.
+				return true;
+			}
+		}
 	}
 }

src/Uno.UI/DirectUI/ElevationHelper.cs

@@ -0,0 +1,42 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+// MUX Reference dxaml\phone\lib\ElevationHelper.cpp, tag winui3/release/1.5.4, commit 98a60c8
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Numerics;
+using System.Text;
+using System.Threading.Tasks;
+using Microsoft.UI.Xaml;
+using Microsoft.UI.Xaml.Media;
+
+namespace DirectUI;
+
+internal static class ElevationHelper
+{
+	// The initial Z offset applied to all elevated controls
+	private const float s_elevationBaseDepth = 32.0f;
+	// This additional Z offset will be applied for each tier of logically parented controls
+	private const float s_elevationIterativeDepth = 8.0f;
+
+	internal static void ApplyThemeShadow(UIElement target)
+	{
+		var themeShadow = new ThemeShadow();
+		target.Shadow = themeShadow;
+	}
+
+	internal static void ApplyElevationEffect(UIElement target, int depth)
+	{
+		// Calculate the Z offset based on the depth of the shadow
+		var calculatedZDepth = s_elevationBaseDepth + (depth * s_elevationIterativeDepth);
+
+		var endTranslation = new Vector3(0.0f, 0.0f, calculatedZDepth);
+
+		// Apply a translation facade value
+		target.Translation = endTranslation;
+
+		// Apply a shadow to the element
+		ApplyThemeShadow(target);
+	}
+}

src/Uno.UI/Generated/3.0.0.0/Microsoft.UI.Xaml.Automation.Peers/MenuFlyoutItemAutomationPeer.cs

@@ -3,20 +3,20 @@
 #pragma warning disable 114 // new keyword hiding
 namespace Microsoft.UI.Xaml.Automation.Peers
 {
-#if __ANDROID__ || __IOS__ || IS_UNIT_TESTS || __WASM__ || __SKIA__ || __NETSTD_REFERENCE__ || __MACOS__
+#if false
 	[global::Uno.NotImplemented]
 #endif
 	public partial class MenuFlyoutItemAutomationPeer : global::Microsoft.UI.Xaml.Automation.Peers.FrameworkElementAutomationPeer, global::Microsoft.UI.Xaml.Automation.Provider.IInvokeProvider
 	{
-#if __ANDROID__ || __IOS__ || IS_UNIT_TESTS || __WASM__ || __SKIA__ || __NETSTD_REFERENCE__ || __MACOS__
+#if false
 		[global::Uno.NotImplemented("__ANDROID__", "__IOS__", "IS_UNIT_TESTS", "__WASM__", "__SKIA__", "__NETSTD_REFERENCE__", "__MACOS__")]
 		public MenuFlyoutItemAutomationPeer(global::Microsoft.UI.Xaml.Controls.MenuFlyoutItem owner) : base(owner)
 		{
 			global::Windows.Foundation.Metadata.ApiInformation.TryRaiseNotImplemented("Microsoft.UI.Xaml.Automation.Peers.MenuFlyoutItemAutomationPeer", "MenuFlyoutItemAutomationPeer.MenuFlyoutItemAutomationPeer(MenuFlyoutItem owner)");
 		}
 #endif
 		// Forced skipping of method Microsoft.UI.Xaml.Automation.Peers.MenuFlyoutItemAutomationPeer.MenuFlyoutItemAutomationPeer(Microsoft.UI.Xaml.Controls.MenuFlyoutItem)
-#if __ANDROID__ || __IOS__ || IS_UNIT_TESTS || __WASM__ || __SKIA__ || __NETSTD_REFERENCE__ || __MACOS__
+#if false
 		[global::Uno.NotImplemented("__ANDROID__", "__IOS__", "IS_UNIT_TESTS", "__WASM__", "__SKIA__", "__NETSTD_REFERENCE__", "__MACOS__")]
 		public void Invoke()
 		{

src/Uno.UI/Generated/3.0.0.0/Microsoft.UI.Xaml.Automation.Peers/MenuFlyoutPresenterAutomationPeer.cs

@@ -3,12 +3,12 @@
 #pragma warning disable 114 // new keyword hiding
 namespace Microsoft.UI.Xaml.Automation.Peers
 {
-#if __ANDROID__ || __IOS__ || IS_UNIT_TESTS || __WASM__ || __SKIA__ || __NETSTD_REFERENCE__ || __MACOS__
+#if false
 	[global::Uno.NotImplemented]
 #endif
 	public partial class MenuFlyoutPresenterAutomationPeer : global::Microsoft.UI.Xaml.Automation.Peers.ItemsControlAutomationPeer
 	{
-#if __ANDROID__ || __IOS__ || IS_UNIT_TESTS || __WASM__ || __SKIA__ || __NETSTD_REFERENCE__ || __MACOS__
+#if false
 		[global::Uno.NotImplemented("__ANDROID__", "__IOS__", "IS_UNIT_TESTS", "__WASM__", "__SKIA__", "__NETSTD_REFERENCE__", "__MACOS__")]
 		public MenuFlyoutPresenterAutomationPeer(global::Microsoft.UI.Xaml.Controls.MenuFlyoutPresenter owner) : base(owner)
 		{

src/Uno.UI/Microsoft/UI/Xaml/Controls/MenuBar/NativeMenuBarPresenter.macOS.cs

@@ -75,7 +75,7 @@ private void ProcessMenuItems(NSMenuItem platformItem, IList<MenuFlyoutItemBase>
 
 						case MenuFlyoutItem flyoutItem:
 							var subPlatformItem2 = new NSMenuItem(flyoutItem.Text, (s, e) => OnItemActivated(flyoutItem)) { Enabled = true };
-							flyoutItem.InvokeClick();
+							flyoutItem.Invoke();
 							platformItem.Submenu.AddItem(subPlatformItem2);
 							break;
 
@@ -89,7 +89,7 @@ private void ProcessMenuItems(NSMenuItem platformItem, IList<MenuFlyoutItemBase>
 
 		private void OnItemActivated(MenuFlyoutItem flyoutItem)
 		{
-			flyoutItem.InvokeClick();
+			flyoutItem.Invoke();
 		}
 
 		protected override Size MeasureOverride(Size availableSize)

src/Uno.UI/UI/Xaml/Automation/ElementNotEnabledException.cs

@@ -1,19 +1,18 @@
 using System;
 
-namespace Microsoft.UI.Xaml.Automation
+namespace Microsoft.UI.Xaml.Automation;
+
+public class ElementNotEnabledException : Exception
 {
-	public class ElementNotEnabledException : Exception
+	public ElementNotEnabledException() : base()
 	{
-		public ElementNotEnabledException() : base()
-		{
-		}
+	}
 
-		public ElementNotEnabledException(string message) : base(message)
-		{
-		}
+	public ElementNotEnabledException(string message) : base(message)
+	{
+	}
 
-		public ElementNotEnabledException(string message, Exception innerException) : base(message, innerException)
-		{
-		}
+	public ElementNotEnabledException(string message, Exception innerException) : base(message, innerException)
+	{
 	}
 }

src/Uno.UI/UI/Xaml/Automation/Peers/AutomationPeer.mux.cs

@@ -6,5 +6,32 @@ public partial class AutomationPeer
 	{
 		[NotImplemented]
 		internal static bool ListenerExistsHelper(AutomationEvents eventId) => false;
+
+		/// <summary>
+		/// Removes the leading and trailing spaces in the provided string and returns the trimmed version
+		/// or an empty string when no characters are left.
+		/// Because it is recommended to set an AppBarButton, AppBarToggleButton, MenuFlyoutItem or ToggleMenuFlyoutItem's
+		/// KeyboardAcceleratorTextOverride to a single space to hide their keyboard accelerator UI, this trimming method
+		/// prevents automation tools like Narrator from emitting a space when navigating to such an element.
+		/// </summary>
+		private protected static string GetTrimmedKeyboardAcceleratorTextOverride(string keyboardAcceleratorTextOverride)
+		{
+			// Return an empty string when the provided keyboardAcceleratorTextOverride is already empty.
+			if (!string.IsNullOrEmpty(keyboardAcceleratorTextOverride))
+			{
+				var trimmedKeyboardAcceleratorTextOverride = keyboardAcceleratorTextOverride.TrimStart(' ');
+
+				// Return an empty string when the remaining string is empty.
+				if (!string.IsNullOrEmpty(trimmedKeyboardAcceleratorTextOverride))
+				{
+					// Trim the trailing spaces as well.
+					trimmedKeyboardAcceleratorTextOverride = trimmedKeyboardAcceleratorTextOverride.TrimEnd(' ');
+					return trimmedKeyboardAcceleratorTextOverride;
+				}
+			}
+
+			// Return an empty string
+			return "";
+		}
 	}
 }