[Windows/macOS] Implement menu key accelerators

src/Controls/docs/Microsoft.Maui.Controls/Accelerator.xml

@@ -120,31 +120,6 @@
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
-    <Member MemberName="Modifiers">
-      <MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable&lt;string&gt; Modifiers { get; set; }" />
-      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1&lt;string&gt; Modifiers" />
-      <MemberSignature Language="DocId" Value="P:Microsoft.Maui.Controls.Accelerator.Modifiers" />
-      <MemberSignature Language="F#" Value="member this.Modifiers : seq&lt;string&gt; with get, set" Usage="Microsoft.Maui.Controls.Accelerator.Modifiers" />
-      <MemberType>Property</MemberType>
-      <AssemblyInfo>
-        <AssemblyVersion>0.0.0.0</AssemblyVersion>
-        <AssemblyVersion>2.0.0.0</AssemblyVersion>
-        <AssemblyName>Microsoft.Maui.Controls.Core</AssemblyName>
-      </AssemblyInfo>
-      <Attributes>
-        <Attribute>
-          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
-        </Attribute>
-      </Attributes>
-      <ReturnValue>
-        <ReturnType>System.Collections.Generic.IEnumerable&lt;System.String&gt;</ReturnType>
-      </ReturnValue>
-      <Docs>
-        <summary>For internal use only.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
-      </Docs>
-    </Member>
     <Member MemberName="op_Implicit">
       <MemberSignature Language="C#" Value="public static implicit operator Microsoft.Maui.Controls.Accelerator (string accelerator);" />
       <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname class Microsoft.Maui.Controls.Accelerator op_Implicit(string accelerator) cil managed" />

src/Controls/samples/Controls.Sample/Pages/Core/ContextFlyoutPage.xaml

@@ -10,10 +10,10 @@
                 <Button Text="Increment by 1 (or right-click me)" Clicked="OnIncrementByOneClicked" FontSize="30" BackgroundColor="DarkGray">
                     <FlyoutBase.ContextFlyout>
                         <MenuFlyout>
-                            <MenuFlyoutItem Text="Increment by 10" Clicked="OnIncrementMenuItemClicked" CommandParameter="10"></MenuFlyoutItem>
-                            <MenuFlyoutItem Text="Increment by 20" Clicked="OnIncrementMenuItemClicked" CommandParameter="20"></MenuFlyoutItem>
-                            <MenuFlyoutItem Text="Increment by 30 (disabled)" Clicked="OnIncrementMenuItemClicked" CommandParameter="30" x:Name="bbb"></MenuFlyoutItem>
-                            <MenuFlyoutItem Text="Increment by 40 (dynamic enabled/disabled)" Command="{Binding DynamicEnabledCommand}" CommandParameter="40"></MenuFlyoutItem>
+                            <MenuFlyoutItem x:Name="Increment10MenuFlyoutItem" Text="Increment by 10" Clicked="OnIncrementMenuItemClicked" CommandParameter="10" />
+                            <MenuFlyoutItem x:Name="Increment20MenuFlyoutItem" Text="Increment by 20" Clicked="OnIncrementMenuItemClicked" CommandParameter="20" />
+                            <MenuFlyoutItem Text="Increment by 30 (disabled)" Clicked="OnIncrementMenuItemClicked" CommandParameter="30" x:Name="bbb" />
+                            <MenuFlyoutItem Text="Increment by 40 (dynamic enabled/disabled)" Command="{Binding DynamicEnabledCommand}" CommandParameter="40" />
                             <MenuFlyoutSubItem Text="More options">
                                 <MenuFlyoutItem Text="Increment by 1,000!" Clicked="OnIncrementMenuItemClicked" CommandParameter="1000"></MenuFlyoutItem>
                                 <MenuFlyoutItem Text="Increment by 1,000,000!" Clicked="OnIncrementMenuItemClicked" CommandParameter="1000000"></MenuFlyoutItem>

src/Controls/samples/Controls.Sample/Pages/Core/ContextFlyoutPage.xaml.cs

@@ -42,6 +42,10 @@ await DisplayAlert(
 			bbb.IsEnabled = false;
 
 			ContextMenuWebView.HandlerChanged += OnWebViewHandlerChanged;
+
+			MenuItem.SetAccelerator(Increment10MenuFlyoutItem, Accelerator.FromString("alt+ctrl+a"));
+			MenuItem.SetAccelerator(Increment20MenuFlyoutItem, Accelerator.FromString("ctrl+b"));
+			MenuItem.SetAccelerator(bbb, Accelerator.FromString("c"));
 		}
 
 

src/Controls/samples/Controls.Sample/Pages/Core/MenuBarPage.cs

@@ -1,10 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 using Microsoft.Maui.Controls;
-using Microsoft.Maui.Graphics;
 
 namespace Maui.Controls.Sample.Pages
 {
@@ -13,6 +10,8 @@ public partial class MenuBarPage
 		public MenuBarPage()
 		{
 			InitializeComponent();
+
+			MenuItem.SetAccelerator(CustomFileMenuFlyoutItem, Accelerator.FromString("ctrl+shift+f"));
 		}
 
 		void ItemClicked(object sender, EventArgs e)

src/Controls/samples/Controls.Sample/Pages/Core/MenuBarPage.xaml

@@ -6,13 +6,13 @@
     xmlns:views="clr-namespace:Maui.Controls.Sample.Pages.Base">
     <views:BasePage.MenuBarItems>
         <MenuBarItem Text="Before File">
-            <MenuFlyoutItem Clicked="ItemClicked" Text="Before File Action"></MenuFlyoutItem>
+            <MenuFlyoutItem Clicked="ItemClicked" Text="Before File Action" Accelerator="b" />
             <MenuFlyoutItem Text="Cool item 1"></MenuFlyoutItem>
             <MenuFlyoutSeparator />
             <MenuFlyoutItem Text="Cool item 2"></MenuFlyoutItem>
         </MenuBarItem>
         <MenuBarItem Text="File">
-            <MenuFlyoutItem Clicked="ItemClicked" Text="Custom File">
+            <MenuFlyoutItem x:Name="CustomFileMenuFlyoutItem" Clicked="ItemClicked" Text="Custom File" >
                 <MenuFlyoutItem.IconImageSource>
                         <FontImageSource
                             FontAutoScalingEnabled="False"
@@ -23,17 +23,17 @@
             </MenuFlyoutItem>
         </MenuBarItem>
         <MenuBarItem Text="Custom Menu">
-            <MenuFlyoutItem Clicked="ItemClicked" Text="Item 1"></MenuFlyoutItem>
+            <MenuFlyoutItem Clicked="ItemClicked" Text="Item 1" Accelerator="ctrl+5" />
             <MenuFlyoutSubItem Clicked="ItemClicked" Text="Sub Menu 1">
-                <MenuFlyoutItem IconImageSource="mic.png" Clicked="ItemClicked" Text="Flyout item 1"></MenuFlyoutItem>
-                <MenuFlyoutItem IconImageSource="coffee.png" Clicked="ItemClicked" Text="Flyout item 2"></MenuFlyoutItem>
+                <MenuFlyoutItem IconImageSource="mic.png" Clicked="ItemClicked" Text="Flyout item 1" Accelerator="Shift+M" />
+                <MenuFlyoutItem IconImageSource="coffee.png" Clicked="ItemClicked" Text="Flyout item 2" Accelerator="ALT+C" />
             </MenuFlyoutSubItem>
         </MenuBarItem>
     </views:BasePage.MenuBarItems>
     <views:BasePage.Content>
         <VerticalStackLayout Margin="12">
-            <Label x:Name="menuLabel" Text="You clicked on Menu Item:"></Label>
-            <Button Text="Toggle Menu Bar Item" Clicked="ToggleMenuBarItem"></Button>
+            <Label x:Name="menuLabel" Text="You clicked on Menu Item:" />
+            <Button Text="Toggle Menu Bar Item" Clicked="ToggleMenuBarItem" />
         </VerticalStackLayout>
     </views:BasePage.Content>
 </views:BasePage>

src/Controls/src/Core/Accelerator.cs

@@ -2,41 +2,61 @@
 using System;
 using System.Collections.Generic;
 using System.ComponentModel;
+using System.Linq;
 
 namespace Microsoft.Maui.Controls
 {
 	/// <include file="../../docs/Microsoft.Maui.Controls/Accelerator.xml" path="Type[@FullName='Microsoft.Maui.Controls.Accelerator']/Docs/*" />
 	[System.ComponentModel.TypeConverter(typeof(AcceleratorTypeConverter))]
-	public class Accelerator
+	public class Accelerator : IAccelerator
 	{
-		const char Separator = '+';
-		string _text;
+		const string Separator = "+";
+		readonly string _text;
 
-		internal Accelerator(string text)
+		internal Accelerator(string text, List<string> modifiers, string key)
 		{
 			if (string.IsNullOrEmpty(text))
 				throw new ArgumentNullException(nameof(text));
+
 			_text = text;
+			Key = key;
+			Modifiers = modifiers;
 		}
 
-		/// <include file="../../docs/Microsoft.Maui.Controls/Accelerator.xml" path="//Member[@MemberName='Modifiers']/Docs/*" />
-		[EditorBrowsable(EditorBrowsableState.Never)]
-		public IEnumerable<string> Modifiers { get; set; }
+		/// <summary>
+		/// Gets the modifiers for the accelerator.
+		/// </summary>
+		public IEnumerable<string> Modifiers { get; }
+
+		IReadOnlyList<string> IAccelerator.Modifiers => Modifiers?.ToList();
 
 		/// <include file="../../docs/Microsoft.Maui.Controls/Accelerator.xml" path="//Member[@MemberName='Keys']/Docs/*" />
 		[EditorBrowsable(EditorBrowsableState.Never)]
-		public IEnumerable<string> Keys { get; set; }
+		[Obsolete("Use Key instead.")]
+		public IEnumerable<string> Keys 
+		{
+			get => Key is null ? null : new[] { Key };
+		}
+
+		/// <summary>
+		/// Gets the key for the accelerator.
+		/// </summary>
+		public string Key { get; }
 
 		/// <include file="../../docs/Microsoft.Maui.Controls/Accelerator.xml" path="//Member[@MemberName='FromString']/Docs/*" />
 		public static Accelerator FromString(string text)
 		{
-			var accelarat = new Accelerator(text);
+			if (string.IsNullOrEmpty(text))
+				throw new ArgumentNullException(nameof(text));
+
+			var str = text;
+			var modifiers = new List<string>();
+			var key = string.Empty;
 
-			var acceleratorParts = text.Split(Separator);
+			var acceleratorParts = text.Split(new[] { Separator }, StringSplitOptions.None);
 
 			if (acceleratorParts.Length > 1)
 			{
-				var modifiers = new List<string>();
 				for (int i = 0; i < acceleratorParts.Length; i++)
 				{
 					var modifierMask = acceleratorParts[i];
@@ -51,27 +71,27 @@ public static Accelerator FromString(string text)
 						case "win":
 							modifiers.Add(modiferMaskLower);
 #if NETSTANDARD2_0
-							text = text.Replace(modifierMask, "");
+							text = text.Replace(modifierMask, string.Empty);
 #else
-							text = text.Replace(modifierMask, "", StringComparison.Ordinal);
+							text = text.Replace(modifierMask, string.Empty, StringComparison.Ordinal);
 #endif
 							break;
 					}
 				}
-				accelarat.Modifiers = modifiers;
-
 			}
 
-			if (text != Separator.ToString())
-			{
-				var keys = text.Split(new char[] { Separator }, StringSplitOptions.RemoveEmptyEntries);
-				accelarat.Keys = keys;
-			}
-			else
+			if (!string.Equals(text, Separator, StringComparison.Ordinal))
 			{
-				accelarat.Keys = new[] { text };
+#if NETSTANDARD2_0
+				text = text.Replace(Separator, string.Empty);
+#else
+				text = text.Replace(Separator, string.Empty, StringComparison.Ordinal);
+#endif
 			}
-			return accelarat;
+
+			key = text;
+
+			return new Accelerator(str, modifiers, key);
 		}
 
 		/// <include file="../../docs/Microsoft.Maui.Controls/Accelerator.xml" path="//Member[@MemberName='ToString']/Docs/*" />

src/Controls/src/Core/Menu/MenuItem.cs

@@ -1,4 +1,4 @@
-#nullable disable
+#nullable disable
 using System;
 using System.Collections.Generic;
 using System.ComponentModel;
@@ -145,6 +145,9 @@ static object CoerceIsEnabledProperty(BindableObject bindable, object value)
 			return false;
 		}
 
+		IReadOnlyList<IAccelerator> IMenuElement.Accelerators =>
+			GetAccelerator(this) is Accelerator acc ? new[] { acc } : null;
+
 		IImageSource IImageSourcePart.Source => this.IconImageSource;
 
 		bool IImageSourcePart.IsAnimationPlaying => false;

src/Controls/src/Core/PublicAPI/net-android/PublicAPI.Unshipped.txt

@@ -1,4 +1,7 @@
 #nullable enable
+*REMOVED*~Microsoft.Maui.Controls.Accelerator.Modifiers.set -> void
+*REMOVED*~Microsoft.Maui.Controls.Accelerator.Keys.set -> void
+~Microsoft.Maui.Controls.Accelerator.Key.get -> string
 *REMOVED*override Microsoft.Maui.Controls.RefreshView.MeasureOverride(double widthConstraint, double heightConstraint) -> Microsoft.Maui.Graphics.Size
 Microsoft.Maui.Controls.Border.~Border() -> void
 Microsoft.Maui.Controls.IWindowCreator

src/Controls/src/Core/PublicAPI/net-ios/PublicAPI.Unshipped.txt

@@ -1,4 +1,7 @@
 #nullable enable
+*REMOVED*~Microsoft.Maui.Controls.Accelerator.Modifiers.set -> void
+*REMOVED*~Microsoft.Maui.Controls.Accelerator.Keys.set -> void
+~Microsoft.Maui.Controls.Accelerator.Key.get -> string
 *REMOVED*override Microsoft.Maui.Controls.RefreshView.MeasureOverride(double widthConstraint, double heightConstraint) -> Microsoft.Maui.Graphics.Size
 Microsoft.Maui.Controls.Border.~Border() -> void
 Microsoft.Maui.Controls.IWindowCreator

src/Controls/src/Core/PublicAPI/net-maccatalyst/PublicAPI.Shipped.txt

@@ -97,8 +97,8 @@
 ~Microsoft.Maui.Controls.AbsoluteLayout.SetLayoutFlags(Microsoft.Maui.IView view, Microsoft.Maui.Layouts.AbsoluteLayoutFlags flags) -> void
 ~Microsoft.Maui.Controls.Accelerator.Keys.get -> System.Collections.Generic.IEnumerable<string>
 ~Microsoft.Maui.Controls.Accelerator.Keys.set -> void
-~Microsoft.Maui.Controls.Accelerator.Modifiers.get -> System.Collections.Generic.IEnumerable<string>
 ~Microsoft.Maui.Controls.Accelerator.Modifiers.set -> void
+~Microsoft.Maui.Controls.Accelerator.Modifiers.get -> System.Collections.Generic.IEnumerable<string>
 ~Microsoft.Maui.Controls.ActivityIndicator.Color.get -> Microsoft.Maui.Graphics.Color
 ~Microsoft.Maui.Controls.ActivityIndicator.Color.set -> void
 ~Microsoft.Maui.Controls.ActivityIndicator.On<T>() -> Microsoft.Maui.Controls.IPlatformElementConfiguration<T, Microsoft.Maui.Controls.ActivityIndicator>

src/Controls/src/Core/PublicAPI/net-maccatalyst/PublicAPI.Unshipped.txt

@@ -1,4 +1,7 @@
 #nullable enable
+*REMOVED*~Microsoft.Maui.Controls.Accelerator.Modifiers.set -> void
+*REMOVED*~Microsoft.Maui.Controls.Accelerator.Keys.set -> void
+~Microsoft.Maui.Controls.Accelerator.Key.get -> string
 *REMOVED*override Microsoft.Maui.Controls.RefreshView.MeasureOverride(double widthConstraint, double heightConstraint) -> Microsoft.Maui.Graphics.Size
 Microsoft.Maui.Controls.Border.~Border() -> void
 Microsoft.Maui.Controls.IWindowCreator

src/Controls/src/Core/PublicAPI/net-tizen/PublicAPI.Unshipped.txt

@@ -1,4 +1,7 @@
-#nullable enable
+#nullable enable
+*REMOVED*~Microsoft.Maui.Controls.Accelerator.Modifiers.set -> void
+*REMOVED*~Microsoft.Maui.Controls.Accelerator.Keys.set -> void
+~Microsoft.Maui.Controls.Accelerator.Key.get -> string
 Microsoft.Maui.Controls.Border.~Border() -> void
 Microsoft.Maui.Controls.IWindowCreator
 Microsoft.Maui.Controls.IWindowCreator.CreateWindow(Microsoft.Maui.Controls.Application! app, Microsoft.Maui.IActivationState? activationState) -> Microsoft.Maui.Controls.Window!

src/Controls/src/Core/PublicAPI/net-windows/PublicAPI.Unshipped.txt

@@ -1,4 +1,7 @@
 #nullable enable
+*REMOVED*~Microsoft.Maui.Controls.Accelerator.Modifiers.set -> void
+*REMOVED*~Microsoft.Maui.Controls.Accelerator.Keys.set -> void
+~Microsoft.Maui.Controls.Accelerator.Key.get -> string
 *REMOVED*override Microsoft.Maui.Controls.RefreshView.MeasureOverride(double widthConstraint, double heightConstraint) -> Microsoft.Maui.Graphics.Size
 Microsoft.Maui.Controls.Border.~Border() -> void
 Microsoft.Maui.Controls.IWindowCreator

src/Controls/src/Core/PublicAPI/net/PublicAPI.Unshipped.txt

@@ -1,4 +1,7 @@
-#nullable enable
+#nullable enable
+*REMOVED*~Microsoft.Maui.Controls.Accelerator.Modifiers.set -> void
+*REMOVED*~Microsoft.Maui.Controls.Accelerator.Keys.set -> void
+~Microsoft.Maui.Controls.Accelerator.Key.get -> string
 *REMOVED*override Microsoft.Maui.Controls.RefreshView.MeasureOverride(double widthConstraint, double heightConstraint) -> Microsoft.Maui.Graphics.Size
 Microsoft.Maui.Controls.Border.~Border() -> void
 Microsoft.Maui.Controls.IWindowCreator

src/Controls/src/Core/PublicAPI/netstandard/PublicAPI.Unshipped.txt

@@ -1,4 +1,7 @@
 #nullable enable
+*REMOVED*~Microsoft.Maui.Controls.Accelerator.Modifiers.set -> void
+*REMOVED*~Microsoft.Maui.Controls.Accelerator.Keys.set -> void
+~Microsoft.Maui.Controls.Accelerator.Key.get -> string
 *REMOVED*override Microsoft.Maui.Controls.RefreshView.MeasureOverride(double widthConstraint, double heightConstraint) -> Microsoft.Maui.Graphics.Size
 Microsoft.Maui.Controls.Border.~Border() -> void
 Microsoft.Maui.Controls.IWindowCreator

src/Controls/tests/Core.UnitTests/AcceleratorUnitTests.cs

@@ -6,7 +6,6 @@
 
 namespace Microsoft.Maui.Controls.Core.UnitTests
 {
-
 	public class AcceleratorUnitTests : BaseTestFixture
 	{
 
@@ -22,19 +21,27 @@ public void AcceleratorThrowsOnNull()
 			Assert.Throws<ArgumentNullException>(() => Accelerator.FromString(null));
 		}
 
-		[Fact]
-		public void AcceleratorFromString()
+		[Theory]
+		[InlineData("ctrl+A")]
+		[InlineData("cmd+A")]
+		[InlineData("ctrl+1")]
+		[InlineData("cmd+1")]
+		[InlineData("ctrl+alt+A")]
+		[InlineData("cmd+alt+A")]
+		public void AcceleratorFromString(string shourtCutKeyBinding)
 		{
-			string shourtCutKeyBinding = "ctrl+A";
 			var accelerator = Accelerator.FromString(shourtCutKeyBinding);
 
 			Assert.Equal(shourtCutKeyBinding, accelerator.ToString());
 		}
 
-		[Fact]
-		public void AcceleratorFromOnlyLetter()
+		[Theory]
+		[InlineData("A")]
+		[InlineData("B")]
+		[InlineData("1")]
+		[InlineData("2")]
+		public void AcceleratorFromOnlyLetter(string shourtCutKeyBinding)
 		{
-			string shourtCutKeyBinding = "A";
 			var accelerator = Accelerator.FromString(shourtCutKeyBinding);
 
 			Assert.Single(accelerator.Keys);
@@ -45,16 +52,18 @@ public void AcceleratorFromOnlyLetter()
 		public void AcceleratorFromLetterAndModifier(TestShortcut shourtcut)
 		{
 			string modifier = shourtcut.Modifier;
+			Assert.NotNull(modifier);
+
 			string key = shourtcut.Key;
-			var accelerator = Accelerator.FromString(shourtcut.ToString());
+			Assert.NotNull(key);
 
+			var accelerator = Accelerator.FromString(shourtcut.ToString());
 			Assert.Single(accelerator.Keys);
 			Assert.Single(accelerator.Modifiers);
 			Assert.Equal(accelerator.Keys.ElementAt(0), shourtcut.Key);
 			Assert.Equal(accelerator.Modifiers.ElementAt(0), shourtcut.Modifier);
 		}
 
-
 		[Fact]
 		public void AcceleratorFromLetterAnd2Modifier()
 		{

src/Core/src/Core/IAccelerator.cs

@@ -0,0 +1,20 @@
+using System.Collections.Generic;
+
+namespace Microsoft.Maui
+{
+	/// <summary>
+	/// Represents a shortcut key for a <see cref="T:Microsoft.Maui.Controls.MenuItem" />.
+	/// </summary>
+	public interface IAccelerator
+	{
+		/// <summary>
+		/// Specifies the virtual key used to modify another keypress. 
+		/// </summary>
+		public IReadOnlyList<string> Modifiers { get; }
+
+		/// <summary>
+		/// Specifies the values for the virtual key.
+		/// </summary>
+		public string Key { get; }
+	}
+}