Improved accessibility with keyboard

Author: 0x5bfa

src/Files.App.Controls/Omnibar/EventArgs.cs

@@ -0,0 +1,11 @@
+// Copyright (c) Files Community
+// Licensed under the MIT License.
+
+namespace Files.App.Controls
+{
+	public record class OmnibarQuerySubmittedEventArgs(OmnibarMode Mode, object? Item, string Text);
+
+	public record class OmnibarSuggestionChosenEventArgs(OmnibarMode Mode, object SelectedItem);
+
+	public record class OmnibarTextChangedEventArgs(OmnibarMode Mode, OmnibarTextChangeReason Reason);
+}

src/Files.App.Controls/Omnibar/Omnibar.Events.cs

@@ -1,6 +1,7 @@
 // Copyright (c) Files Community
 // Licensed under the MIT License.
 
+using Microsoft.UI.Xaml.Input;
 using Windows.System;
 
 namespace Files.App.Controls
@@ -40,45 +41,75 @@ private void AutoSuggestBox_LostFocus(object sender, RoutedEventArgs e)
 			TryToggleIsSuggestionsPopupOpen(false);
 		}
 
-		private void AutoSuggestBox_KeyDown(object sender, Microsoft.UI.Xaml.Input.KeyRoutedEventArgs e)
+		private void AutoSuggestBox_KeyDown(object sender, KeyRoutedEventArgs e)
 		{
 			if (e.Key is VirtualKey.Enter)
 			{
 				e.Handled = true;
 
-				// TODO
+				SubmitQuery(_textBoxSuggestionsPopup.IsOpen && _textBoxSuggestionsListView.SelectedIndex is not -1 ? _textBoxSuggestionsListView.SelectedItem : null);
 			}
 			else if ((e.Key == VirtualKey.Up || e.Key == VirtualKey.Down) && _textBoxSuggestionsPopup.IsOpen)
 			{
 				e.Handled = true;
 
-				// TODO
+				var currentIndex = _textBoxSuggestionsListView.SelectedIndex;
+				var nextIndex = currentIndex;
+				var suggestionsCount = _textBoxSuggestionsListView.Items.Count;
+
+				if (e.Key is VirtualKey.Up)
+				{
+					nextIndex--;
+				}
+				else if (e.Key is VirtualKey.Down)
+				{
+					nextIndex++;
+				}
+
+				if (0 > nextIndex || nextIndex >= suggestionsCount)
+				{
+					RevertTextToUserInput();
+				}
+				else
+				{
+					_textBoxSuggestionsListView.SelectedIndex = nextIndex;
+
+					ChooseSuggestionItem(_textBoxSuggestionsListView.SelectedItem);
+				}
 			}
 			else if (e.Key == VirtualKey.Escape && _textBoxSuggestionsPopup.IsOpen)
 			{
 				e.Handled = true;
 
-				// TODO
+				RevertTextToUserInput();
+				_textBoxSuggestionsPopup.IsOpen = false;
 			}
 			else
 			{
-				// TODO
+				_textChangeReason = OmnibarTextChangeReason.UserInput;
 			}
 		}
 
 		private void AutoSuggestBox_TextChanged(object sender, TextChangedEventArgs e)
 		{
-			// After a suggestion item was chosen, text will be changed but we don't want to show suggestions again
-			if (_suggestionWasClicked)
+			CurrentSelectedMode!.Text = _textBox.Text;
+
+			// UpdateSuggestionListView();
+
+			if (_textChangeReason is not OmnibarTextChangeReason.SuggestionChosen and
+				not OmnibarTextChangeReason.ProgrammaticChange)
 			{
-				_suggestionWasClicked = false;
-				return;
+				_textChangeReason = OmnibarTextChangeReason.UserInput;
+				_userInput = _textBox.Text;
 			}
 
-			TryToggleIsSuggestionsPopupOpen(true);
+			TextChanged?.Invoke(this, new(CurrentSelectedMode, _textChangeReason));
+
+			// Reset
+			_textChangeReason = OmnibarTextChangeReason.None;
 		}
 
-		private void AutoSuggestBoxSuggestionsPopup_GettingFocus(UIElement sender, Microsoft.UI.Xaml.Input.GettingFocusEventArgs args)
+		private void AutoSuggestBoxSuggestionsPopup_GettingFocus(UIElement sender, GettingFocusEventArgs args)
 		{
 			args.TryCancel();
 		}
@@ -88,21 +119,8 @@ private void AutoSuggestBoxSuggestionsListView_ItemClick(object sender, ItemClic
 			if (CurrentSelectedMode is null)
 				return;
 
-			// Get the text to put into the text box from the chosen suggestion item
-			if (e.ClickedItem is string text)
-			{
-				CurrentSelectedMode.Text = text;
-			}
-			else
-			{
-				CurrentSelectedMode.Text = CurrentSelectedMode.DisplayMemberPath is null
-					? e.ClickedItem.ToString()
-					: e.ClickedItem.GetType().GetProperty(CurrentSelectedMode.DisplayMemberPath)?.GetValue(e.ClickedItem)?.ToString();
-			}
-
-			TryToggleIsSuggestionsPopupOpen(false);
-
-			_suggestionWasClicked = true;
+			ChooseSuggestionItem(e.ClickedItem);
+			SubmitQuery(e.ClickedItem);
 		}
 	}
 }

src/Files.App.Controls/Omnibar/Omnibar.cs

@@ -5,6 +5,7 @@
 using Microsoft.UI.Xaml.Markup;
 using Microsoft.UI.Xaml.Media.Animation;
 using Windows.Foundation;
+using static System.Net.Mime.MediaTypeNames;
 
 namespace Files.App.Controls
 {
@@ -29,11 +30,14 @@ public partial class Omnibar : Control
 		private ListView _textBoxSuggestionsListView = null!;
 
 		private bool _isFocused;
-		private bool _suggestionWasClicked;
+		private string _userInput = string.Empty;
+		private OmnibarTextChangeReason _textChangeReason = OmnibarTextChangeReason.None;
 
 		// Events
 
 		public event TypedEventHandler<Omnibar, OmnibarQuerySubmittedEventArgs>? QuerySubmitted;
+		public event TypedEventHandler<Omnibar, OmnibarSuggestionChosenEventArgs>? SuggestionChosen;
+		public event TypedEventHandler<Omnibar, OmnibarTextChangedEventArgs>? TextChanged;
 
 		// Constructor
 
@@ -184,5 +188,59 @@ public bool TryToggleIsSuggestionsPopupOpen(bool wantToOpen)
 
 			return false;
 		}
+
+		public void ChooseSuggestionItem(object obj)
+		{
+			if (CurrentSelectedMode is null)
+				return;
+
+			if (CurrentSelectedMode.UpdateTextOnSelect)
+			{
+				_textChangeReason = OmnibarTextChangeReason.SuggestionChosen;
+				CurrentSelectedMode.Text = GetObjectText(obj);
+			}
+
+			SuggestionChosen?.Invoke(this, new(CurrentSelectedMode, obj));
+
+			// Move the cursor to the end of the TextBox
+			_textBox?.Select(_textBox.Text.Length, 0);
+		}
+
+		private void SubmitQuery(object? item)
+		{
+			if (CurrentSelectedMode is null)
+				return;
+
+			QuerySubmitted?.Invoke(this, new OmnibarQuerySubmittedEventArgs(CurrentSelectedMode, item, _textBox.Text));
+
+			_textBoxSuggestionsPopup.IsOpen = false;
+		}
+
+		private string GetObjectText(object obj)
+		{
+			if (CurrentSelectedMode is null)
+				return string.Empty;
+
+			// Get the text to put into the text box from the chosen suggestion item
+			return obj is string text
+				? text
+				: CurrentSelectedMode.DisplayMemberPath is null
+					? obj.ToString() ?? string.Empty
+					: obj.GetType().GetProperty(CurrentSelectedMode.DisplayMemberPath)?.GetValue(obj)?.ToString() ?? string.Empty;
+		}
+
+		private void RevertTextToUserInput()
+		{
+			if (CurrentSelectedMode is null)
+				return;
+
+			_textBoxSuggestionsListView.SelectedIndex = -1;
+			_textChangeReason = OmnibarTextChangeReason.ProgrammaticChange;
+
+			CurrentSelectedMode.Text = _userInput ?? "";
+
+			// Move the cursor to the end of the TextBox
+			_textBox?.Select(_textBox.Text.Length, 0);
+		}
 	}
 }

src/Files.App.Controls/Omnibar/Omnibar.xaml

@@ -97,7 +97,7 @@
 									IsItemClickEnabled="True"
 									ItemTemplate="{Binding CurrentSelectedMode.SuggestionItemTemplate, RelativeSource={RelativeSource TemplatedParent}, Mode=OneWay}"
 									ItemsSource="{Binding CurrentSelectedMode.SuggestionItemsSource, RelativeSource={RelativeSource TemplatedParent}, Mode=OneWay}"
-									SelectionMode="None">
+									SelectionMode="Single">
 									<ListView.ItemContainerTransitions />
 								</ListView>
 							</Border>

src/Files.App.Controls/Omnibar/OmnibarEventArgs.cs

@@ -36,5 +36,8 @@ public partial class OmnibarMode
 
 		[GeneratedDependencyProperty]
 		public partial string? DisplayMemberPath { get; set; }
+
+		[GeneratedDependencyProperty(DefaultValue = true)]
+		public partial bool UpdateTextOnSelect { get; set; }
 	}
 }

src/Files.App.Controls/Omnibar/OmnibarMode.Properties.cs

@@ -0,0 +1,16 @@
+// Copyright (c) Files Community
+// Licensed under the MIT License.
+
+namespace Files.App.Controls
+{
+	public enum OmnibarTextChangeReason
+	{
+		UserInput,
+
+		SuggestionChosen,
+
+		ProgrammaticChange,
+
+		None,
+	}
+}