Rename Accelerator to KeyboardAccelerator and Refactor APIs

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

@@ -14,13 +14,12 @@
                             <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="Menu Item with Suboptions" IsEnabled="False">
-                                <MenuFlyoutItem Text="Increment by 1,000!" Clicked="OnIncrementMenuItemClicked" CommandParameter="1000"></MenuFlyoutItem>
-                                <MenuFlyoutItem Text="Increment by 1,000,000!" Clicked="OnIncrementMenuItemClicked" CommandParameter="1000000"></MenuFlyoutItem>
-                            </MenuFlyoutSubItem>
-                            <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>
+                            <MenuFlyoutSubItem Text="Increment by 500" Clicked="OnIncrementMenuItemClicked" CommandParameter="500">
+                                <MenuFlyoutSubItem.KeyboardAccelerators>
+                                    <KeyboardAccelerator Modifiers="Alt" Key="F" />
+                                </MenuFlyoutSubItem.KeyboardAccelerators>
+                                <MenuFlyoutItem x:Name="Increment1000MenuFlyoutItem" Text="Increment by 1,000!" Clicked="OnIncrementMenuItemClicked" CommandParameter="1000"></MenuFlyoutItem>
+                                <MenuFlyoutItem x:Name="Increment1000000MenuFlyoutItem" Text="Increment by 1,000,000!" Clicked="OnIncrementMenuItemClicked" CommandParameter="1000000"></MenuFlyoutItem>
                             </MenuFlyoutSubItem>
                         </MenuFlyout>
                     </FlyoutBase.ContextFlyout>

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

@@ -43,12 +43,13 @@ await DisplayAlert(
 
 			ContextMenuWebView.HandlerChanged += OnWebViewHandlerChanged;
 
-			MenuItem.SetAccelerator(Increment10MenuFlyoutItem, Accelerator.FromString("alt+ctrl+a"));
-			MenuItem.SetAccelerator(Increment20MenuFlyoutItem, Accelerator.FromString("ctrl+b"));
-			MenuItem.SetAccelerator(bbb, Accelerator.FromString("c"));
+			Increment10MenuFlyoutItem.KeyboardAccelerators.Add(new KeyboardAccelerator() { Modifiers=KeyboardAcceleratorModifiers.Alt|KeyboardAcceleratorModifiers.Ctrl, Key="A" });
+			Increment20MenuFlyoutItem.KeyboardAccelerators.Add(new KeyboardAccelerator() { Modifiers = KeyboardAcceleratorModifiers.Shift, Key = "B" });
+			Increment1000MenuFlyoutItem.KeyboardAccelerators.Add(new KeyboardAccelerator() { Modifiers = KeyboardAcceleratorModifiers.Ctrl, Key = "t" });
+			Increment1000000MenuFlyoutItem.KeyboardAccelerators.Add(new KeyboardAccelerator() { Modifiers = KeyboardAcceleratorModifiers.Alt, Key = "b" });
+			bbb.KeyboardAccelerators.Add(new KeyboardAccelerator() { Key = "C" });
 		}
 
-
 		void OnWebViewHandlerChanged(object sender, EventArgs e)
 		{
 			if (ContextMenuWebView.Handler != null)

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

@@ -1,5 +1,6 @@
 using System;
 using System.Linq;
+using Microsoft.Maui;
 using Microsoft.Maui.Controls;
 
 namespace Maui.Controls.Sample.Pages
@@ -10,7 +11,19 @@ public MenuBarPage()
 		{
 			InitializeComponent();
 
-			MenuItem.SetAccelerator(CustomFileMenuFlyoutItem, Accelerator.FromString("ctrl+shift+f"));
+			CustomFileMenuFlyoutItem.KeyboardAccelerators.Add(
+				new KeyboardAccelerator() { 
+					Modifiers = KeyboardAcceleratorModifiers.Ctrl|KeyboardAcceleratorModifiers.Shift,
+					Key = "F" 
+				}
+			);
+			CustomFileMenuFlyoutItem.KeyboardAccelerators.Add(
+				new KeyboardAccelerator()
+				{
+					Modifiers = KeyboardAcceleratorModifiers.Shift,
+					Key = "F"
+				}
+			);
 		}
 
 		void ItemClicked(object sender, EventArgs e)

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

@@ -6,9 +6,12 @@
     xmlns:views="clr-namespace:Maui.Controls.Sample.Pages.Base">
     <views:BasePage.MenuBarItems>
         <MenuBarItem Text="Before File">
-            <MenuFlyoutItem Text="Cool item 1" />
-            <MenuFlyoutItem Clicked="ItemClicked" Text="Before File Action" Accelerator="b" />
-            <MenuFlyoutItem Text="Cool item 1" />
+            <MenuFlyoutItem Clicked="ItemClicked" Text="Before File Action">
+                <MenuFlyoutItem.KeyboardAccelerators>
+                    <KeyboardAccelerator Key="b" />
+                </MenuFlyoutItem.KeyboardAccelerators>
+            </MenuFlyoutItem>
+            <MenuFlyoutItem Text="Cool item 1"></MenuFlyoutItem>
             <MenuFlyoutSeparator />
             <MenuFlyoutItem Text="Cool item 2 (Disabled)" IsEnabled="False" />
         </MenuBarItem>
@@ -24,10 +27,22 @@
             </MenuFlyoutItem>
         </MenuBarItem>
         <MenuBarItem Text="Custom Menu">
-            <MenuFlyoutItem Clicked="ItemClicked" Text="Item 1" Accelerator="ctrl+5" />
+            <MenuFlyoutItem Clicked="ItemClicked" Text="Item 1">
+                <MenuFlyoutItem.KeyboardAccelerators>
+                    <KeyboardAccelerator Modifiers="{OnPlatform WinUI=Ctrl, MacCatalyst=Cmd}" Key="1" />
+                </MenuFlyoutItem.KeyboardAccelerators>
+            </MenuFlyoutItem>
             <MenuFlyoutSubItem Clicked="ItemClicked" Text="Sub Menu 1">
-                <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" />
+                <MenuFlyoutItem IconImageSource="mic.png" Clicked="ItemClicked" Text="Flyout item 1">
+                    <MenuFlyoutItem.KeyboardAccelerators>
+                        <KeyboardAccelerator Modifiers="Windows,Shift" Key="A" />
+                    </MenuFlyoutItem.KeyboardAccelerators>
+                </MenuFlyoutItem>
+                <MenuFlyoutItem IconImageSource="coffee.png" Clicked="ItemClicked" Text="Flyout item 2">
+                    <MenuFlyoutItem.KeyboardAccelerators>
+                        <KeyboardAccelerator Modifiers="Alt" Key="C"  />
+                    </MenuFlyoutItem.KeyboardAccelerators>
+                </MenuFlyoutItem>
             </MenuFlyoutSubItem>
             <MenuFlyoutItem Clicked="ItemClicked" Text="Item 2 (Disabled)" IsEnabled="False" />
         </MenuBarItem>

src/Controls/src/Core/Accelerator.cs

@@ -7,56 +7,37 @@ 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 : IAccelerator
+	[Obsolete("Use KeyboardAccelerator instead.")]
+	public class Accelerator
 	{
-		const string Separator = "+";
-		readonly string _text;
-		readonly List<string> _modifiers;
+		const char Separator = '+';
+		string _text;
 
-		internal Accelerator(string text, IEnumerable<string> modifiers, string key)
+		internal Accelerator(string text)
 		{
 			if (string.IsNullOrEmpty(text))
 				throw new ArgumentNullException(nameof(text));
-
 			_text = text;
-			Key = key;
-			_modifiers = new List<string>(modifiers);
 		}
 
-		/// <summary>
-		/// Gets the modifiers for the accelerator.
-		/// </summary>
-		public IEnumerable<string> Modifiers => _modifiers;
-
-		IReadOnlyList<string> IAccelerator.Modifiers => _modifiers;
+		/// <include file="../../docs/Microsoft.Maui.Controls/Accelerator.xml" path="//Member[@MemberName='Modifiers']/Docs/*" />
+		[EditorBrowsable(EditorBrowsableState.Never)]
+		public IEnumerable<string> Modifiers { get; set; }
 
 		/// <include file="../../docs/Microsoft.Maui.Controls/Accelerator.xml" path="//Member[@MemberName='Keys']/Docs/*" />
 		[EditorBrowsable(EditorBrowsableState.Never)]
-		[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; }
+		public IEnumerable<string> Keys { get; set; }
 
 		/// <include file="../../docs/Microsoft.Maui.Controls/Accelerator.xml" path="//Member[@MemberName='FromString']/Docs/*" />
 		public static Accelerator FromString(string text)
 		{
-			if (string.IsNullOrEmpty(text))
-				throw new ArgumentNullException(nameof(text));
-
-			var str = text;
-			var modifiers = new List<string>();
-			var key = string.Empty;
+			var accelarat = new Accelerator(text);
 
-			var acceleratorParts = text.Split(new[] { Separator }, StringSplitOptions.None);
+			var acceleratorParts = text.Split(Separator);
 
 			if (acceleratorParts.Length > 1)
 			{
+				var modifiers = new List<string>();
 				for (int i = 0; i < acceleratorParts.Length; i++)
 				{
 					var modifierMask = acceleratorParts[i];
@@ -71,27 +52,27 @@ public static Accelerator FromString(string text)
 						case "win":
 							modifiers.Add(modiferMaskLower);
 #if NETSTANDARD2_0
-							text = text.Replace(modifierMask, string.Empty);
+							text = text.Replace(modifierMask, "");
 #else
-							text = text.Replace(modifierMask, string.Empty, StringComparison.Ordinal);
+							text = text.Replace(modifierMask, "", StringComparison.Ordinal);
 #endif
 							break;
 					}
 				}
+				accelarat.Modifiers = modifiers;
+
 			}
 
-			if (!string.Equals(text, Separator, StringComparison.Ordinal))
+			if (text != Separator.ToString())
 			{
-#if NETSTANDARD2_0
-				text = text.Replace(Separator, string.Empty);
-#else
-				text = text.Replace(Separator, string.Empty, StringComparison.Ordinal);
-#endif
+				var keys = text.Split(new char[] { Separator }, StringSplitOptions.RemoveEmptyEntries);
+				accelarat.Keys = keys;
 			}
-
-			key = text;
-
-			return new Accelerator(str, modifiers, key);
+			else
+			{
+				accelarat.Keys = new[] { text };
+			}
+			return accelarat;
 		}
 
 		/// <include file="../../docs/Microsoft.Maui.Controls/Accelerator.xml" path="//Member[@MemberName='ToString']/Docs/*" />
@@ -126,4 +107,4 @@ public static implicit operator Accelerator(string accelerator)
 			return FromString(accelerator);
 		}
 	}
-}
+}

src/Controls/src/Core/AcceleratorTypeConverter.cs

@@ -13,6 +13,7 @@ namespace Microsoft.Maui.Controls
 	/// in any combination of upper or lower case letters, as well as any available keys on the platform.
 	/// The returned <see cref="Accelerator" /> has its <see cref="Accelerator.Modifiers" /> array filled with the specified modifiers,
 	/// and its <see cref="Accelerator.Keys" /> array filled with the remaining keys.</remarks>
+	[Obsolete("Use KeyboardAccelerator instead.")]
 	public class AcceleratorTypeConverter : TypeConverter
 	{
 		public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)
@@ -39,4 +40,4 @@ public override object ConvertTo(ITypeDescriptorContext context, CultureInfo cul
 			return acc.ToString();
 		}
 	}
-}
+}

src/Controls/src/Core/KeyboardAccelerator.cs

@@ -0,0 +1,36 @@
+namespace Microsoft.Maui.Controls
+{
+	/// <summary>
+	/// Represents a shortcut key for a <see cref="MenuFlyoutItem"/>.
+	/// </summary>
+	public class KeyboardAccelerator : BindableObject, IKeyboardAccelerator
+	{
+		/// <summary>
+		/// Bindable property for <see cref="Modifiers"/>.
+		/// </summary>
+		public static readonly BindableProperty ModifiersProperty = BindableProperty.Create(nameof(Modifiers), typeof(KeyboardAcceleratorModifiers), typeof(KeyboardAccelerator), KeyboardAcceleratorModifiers.None);
+
+		/// <summary>
+		/// Bindable property for <see cref="Key"/>.
+		/// </summary>
+		public static readonly BindableProperty KeyProperty = BindableProperty.Create(nameof(Key), typeof(string), typeof(KeyboardAccelerator), null);
+
+		/// <summary>
+		/// Identifies the modifiers for the keyboard accelerator.
+		/// </summary>
+		public KeyboardAcceleratorModifiers Modifiers 
+		{
+			get => (KeyboardAcceleratorModifiers)GetValue(ModifiersProperty);
+			set => SetValue(ModifiersProperty, value);
+		}
+
+		/// <summary>
+		/// Identifies the key for the keyboard accelerator.
+		/// </summary>
+		public string? Key
+		{
+			get => (string?)GetValue(KeyProperty);
+			set => SetValue(KeyProperty, value);
+		}
+	}
+}

src/Controls/src/Core/Menu/MenuFlyoutItem.cs

@@ -1,12 +1,32 @@
-using System;
 using System.Collections.Generic;
-using System.ComponentModel;
-using System.Windows.Input;
-using Microsoft.Maui.Controls.StyleSheets;
+using System.Collections.ObjectModel;
 
 namespace Microsoft.Maui.Controls
 {
-	public partial class MenuFlyoutItem : MenuItem, IMenuFlyoutItem
-	{
+	/// <summary>
+	/// Represents a MenuFlyoutItem.
+	/// </summary>
+    public partial class MenuFlyoutItem : MenuItem, IMenuFlyoutItem
+    {
+		/// <summary>
+		/// Initializes a new MenuFlyoutItem instance.
+		/// </summary>
+		public MenuFlyoutItem()
+        {
+            var collection = new ObservableCollection<KeyboardAccelerator>();
+            collection.CollectionChanged += (sender, e) => OnPropertyChanged(nameof(KeyboardAccelerators));
+            KeyboardAccelerators = collection;
+        }
+
+		/// <summary>
+		/// Gets the list of KeyboardAccelerators for the MenuFlyoutItem.
+		/// </summary>
+		public IList<KeyboardAccelerator> KeyboardAccelerators { get; }
+
+#if PLATFORM
+		IReadOnlyList<IKeyboardAccelerator>? IMenuFlyoutItem.KeyboardAccelerators => KeyboardAccelerators.AsReadOnly();
+#else
+		IReadOnlyList<IKeyboardAccelerator>? IMenuFlyoutItem.KeyboardAccelerators => new List<IKeyboardAccelerator>(KeyboardAccelerators);
+#endif
 	}
 }

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

@@ -13,6 +13,7 @@ namespace Microsoft.Maui.Controls
 	public partial class MenuItem : BaseMenuItem, IMenuItemController, IStyleSelectable, ICommandElement, IMenuElement, IPropertyPropagationController
 	{
 		/// <summary>Bindable property for <see cref="Accelerator"/>.</summary>
+		[Obsolete("Use MenuFlyoutItem.KeyboardAcceleratorsProperty instead.")]
 		public static readonly BindableProperty AcceleratorProperty = BindableProperty.CreateAttached(nameof(Accelerator), typeof(Accelerator), typeof(MenuItem), null);
 
 		/// <summary>Bindable property for <see cref="Command"/>.</summary>
@@ -41,9 +42,11 @@ public partial class MenuItem : BaseMenuItem, IMenuItemController, IStyleSelecta
 		public static readonly BindableProperty TextProperty = BindableProperty.Create(nameof(Text), typeof(string), typeof(MenuItem), null);
 
 		/// <include file="../../docs/Microsoft.Maui.Controls/MenuItem.xml" path="//Member[@MemberName='GetAccelerator']/Docs/*" />
+		[Obsolete("Use MenuFlyoutItem.KeyboardAcceleratorsProperty instead.")] 
 		public static Accelerator GetAccelerator(BindableObject bindable) => (Accelerator)bindable.GetValue(AcceleratorProperty);
 
 		/// <include file="../../docs/Microsoft.Maui.Controls/MenuItem.xml" path="//Member[@MemberName='SetAccelerator']/Docs/*" />
+		[Obsolete("Use MenuFlyoutItem.KeyboardAcceleratorsProperty instead.")] 
 		public static void SetAccelerator(BindableObject bindable, Accelerator value) => bindable.SetValue(AcceleratorProperty, value);
 
 		internal readonly MergedStyle _mergedStyle;
@@ -164,9 +167,6 @@ static object CoerceIsEnabledProperty(BindableObject bindable, object value)
 			return true;
 		}
 
-		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,6 +1,5 @@
 #nullable enable
-*REMOVED*~Microsoft.Maui.Controls.Accelerator.Modifiers.set -> void
-*REMOVED*~Microsoft.Maui.Controls.Accelerator.Keys.set -> void
+Microsoft.Maui.Controls.KeyboardAccelerator
 Microsoft.Maui.Controls.DragEventArgs.Data.get -> Microsoft.Maui.Controls.DataPackage!
 Microsoft.Maui.Controls.DragEventArgs.DragEventArgs(Microsoft.Maui.Controls.DataPackage! dataPackage) -> void
 Microsoft.Maui.Controls.DragGestureRecognizer.DragStarting -> System.EventHandler<Microsoft.Maui.Controls.DragStartingEventArgs!>?
@@ -18,6 +17,12 @@ Microsoft.Maui.Controls.DropEventArgs.Data.get -> Microsoft.Maui.Controls.DataPa
 Microsoft.Maui.Controls.DropEventArgs.DropEventArgs(Microsoft.Maui.Controls.DataPackageView! view) -> void
 Microsoft.Maui.Controls.Handlers.Compatibility.ViewRenderer<TElement, TPlatformView>.ViewRenderer(Android.Content.Context! context, Microsoft.Maui.IPropertyMapper! mapper, Microsoft.Maui.CommandMapper? commandMapper = null) -> void
 Microsoft.Maui.Controls.Handlers.Compatibility.VisualElementRenderer<TElement>.VisualElementRenderer(Android.Content.Context! context, Microsoft.Maui.IPropertyMapper! mapper, Microsoft.Maui.CommandMapper? commandMapper = null) -> void
+Microsoft.Maui.Controls.KeyboardAccelerator.Key.get -> string?
+Microsoft.Maui.Controls.KeyboardAccelerator.Key.set -> void
+Microsoft.Maui.Controls.KeyboardAccelerator.KeyboardAccelerator() -> void
+Microsoft.Maui.Controls.KeyboardAccelerator.Modifiers.get -> Microsoft.Maui.KeyboardAcceleratorModifiers
+Microsoft.Maui.Controls.KeyboardAccelerator.Modifiers.set -> void
+Microsoft.Maui.Controls.MenuFlyoutItem.KeyboardAccelerators.get -> System.Collections.Generic.IList<Microsoft.Maui.Controls.KeyboardAccelerator!>!
 Microsoft.Maui.Controls.InputView.CursorPosition.get -> int
 Microsoft.Maui.Controls.InputView.CursorPosition.set -> void
 Microsoft.Maui.Controls.InputView.FontAttributes.get -> Microsoft.Maui.Controls.FontAttributes
@@ -38,6 +43,8 @@ Microsoft.Maui.Controls.PointerGestureRecognizer.PointerReleasedCommand.get -> S
 Microsoft.Maui.Controls.PointerGestureRecognizer.PointerReleasedCommand.set -> void
 Microsoft.Maui.Controls.PointerGestureRecognizer.PointerReleasedCommandParameter.get -> object!
 Microsoft.Maui.Controls.PointerGestureRecognizer.PointerReleasedCommandParameter.set -> void
+static readonly Microsoft.Maui.Controls.KeyboardAccelerator.KeyProperty -> Microsoft.Maui.Controls.BindableProperty!
+static readonly Microsoft.Maui.Controls.KeyboardAccelerator.ModifiersProperty -> Microsoft.Maui.Controls.BindableProperty!
 static readonly Microsoft.Maui.Controls.DragGestureRecognizer.CanDragProperty -> Microsoft.Maui.Controls.BindableProperty!
 static readonly Microsoft.Maui.Controls.DragGestureRecognizer.DragStartingCommandParameterProperty -> Microsoft.Maui.Controls.BindableProperty!
 static readonly Microsoft.Maui.Controls.DragGestureRecognizer.DragStartingCommandProperty -> Microsoft.Maui.Controls.BindableProperty!
@@ -50,7 +57,6 @@ static readonly Microsoft.Maui.Controls.PointerGestureRecognizer.PointerReleased
 virtual Microsoft.Maui.Controls.DragEventArgs.GetPosition(Microsoft.Maui.Controls.Element? relativeTo) -> Microsoft.Maui.Graphics.Point?
 virtual Microsoft.Maui.Controls.DragStartingEventArgs.GetPosition(Microsoft.Maui.Controls.Element? relativeTo) -> Microsoft.Maui.Graphics.Point?
 virtual Microsoft.Maui.Controls.DropEventArgs.GetPosition(Microsoft.Maui.Controls.Element? relativeTo) -> Microsoft.Maui.Graphics.Point?
-~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