Fix shell search suggestion pick after dismissing OSK with B

AutoSuggestBox.SuggestionChosen throws InvalidCastException for custom suggestion items on Xbox. Handle gamepad A/Enter via PreviewKeyDown, mouse/touch via Tapped, and keyboard via QuerySubmitted.ChosenSuggestion. Suppress spurious QuerySubmitted after B dismisses the OSK.

Author: CyberoniOntoni

src/JellyBox/MainPage.xaml

@@ -27,18 +27,22 @@
                 IsTabStop="False"
                 PlaceholderText="Search movies and TV shows"
                 Style="{StaticResource SearchAutoSuggestBox}"
+                UpdateTextOnSelect="False"
                 ItemsSource="{x:Bind ViewModel.Search.Suggestions, Mode=OneWay}"
                 TextChanged="SearchBox_TextChanged"
                 QuerySubmitted="SearchBox_QuerySubmitted"
-                SuggestionChosen="SearchBox_SuggestionChosen"
                 LostFocus="SearchBox_LostFocus"
                 XYFocusKeyboardNavigation="Enabled">
                 <AutoSuggestBox.QueryIcon>
                     <SymbolIcon Symbol="Find" />
                 </AutoSuggestBox.QueryIcon>
                 <AutoSuggestBox.ItemTemplate>
                     <DataTemplate x:DataType="models:SearchSuggestion">
-                        <StackPanel Orientation="Horizontal" Spacing="12" Padding="4,10">
+                        <StackPanel
+                            Orientation="Horizontal"
+                            Spacing="12"
+                            Padding="4,10"
+                            Tapped="SearchSuggestionItem_Tapped">
                             <FontIcon
                                 FontFamily="{StaticResource SegoeIcons}"
                                 Glyph="{x:Bind g:Glyphs.Search}"

src/JellyBox/MainPage.xaml.cs

@@ -1,4 +1,5 @@
 using System.ComponentModel;
+using System.Diagnostics.CodeAnalysis;
 using JellyBox.Models;
 using JellyBox.Services;
 using JellyBox.ViewModels;
@@ -8,14 +9,15 @@
 using Windows.UI.Xaml;
 using Windows.UI.Xaml.Controls;
 using Windows.UI.Xaml.Input;
+using Windows.UI.Xaml.Media;
 using Windows.UI.Xaml.Navigation;
 
 namespace JellyBox;
 
 internal sealed partial class MainPage : Page
 {
     private FrameworkElement? _lastFocusedElement;
-    private bool _ignoreNextQuerySubmitted;
+    private int _ignoreQuerySubmittedCount;
     private bool _suppressSearchTextSync;
 
     public MainPage()
@@ -25,6 +27,7 @@ public MainPage()
         ViewModel = AppServices.Instance.ServiceProvider.GetRequiredService<MainPageViewModel>();
         ViewModel.IsMenuOpenChanged += OnIsMenuOpenChanged;
         ViewModel.Search.PropertyChanged += OnSearchPropertyChanged;
+        PreviewKeyDown += MainPage_PreviewKeyDown;
 
         // Cache the page state so the ContentFrame's BackStack can be preserved
         NavigationCacheMode = NavigationCacheMode.Required;
@@ -41,6 +44,7 @@ public MainPage()
         {
             ContentFrame.Navigated -= ContentFrameNavigated;
             ViewModel.Search.PropertyChanged -= OnSearchPropertyChanged;
+            PreviewKeyDown -= MainPage_PreviewKeyDown;
         };
     }
 
@@ -135,9 +139,48 @@ private void ContentFrameNavigated(object sender, NavigationEventArgs e)
 
     private void SearchBox_LostFocus(object sender, RoutedEventArgs e)
     {
+        // Keep the search box in the focus order while suggestions are open so the user
+        // can dismiss the OSK with B and navigate the list with the d-pad.
+        if (ViewModel.Search.Suggestions.Count > 0)
+        {
+            return;
+        }
+
         SearchBox.IsTabStop = false;
     }
 
+    private void MainPage_PreviewKeyDown(object sender, KeyRoutedEventArgs e)
+    {
+        if (!IsSearchSuggestionsActive())
+        {
+            return;
+        }
+
+        if (GamepadInput.IsBackKey(e.Key))
+        {
+            // Dismissing the OSK can spuriously fire QuerySubmitted with the first suggestion.
+            _ignoreQuerySubmittedCount = 2;
+            return;
+        }
+
+        if (GamepadInput.IsAcceptKey(e.Key) && TryGetFocusedSuggestion(out SearchSuggestion? suggestion))
+        {
+            // Handle gamepad selection here instead of SuggestionChosen, which throws
+            // InvalidCastException for custom suggestion items inside AutoSuggestBox on Xbox.
+            e.Handled = true;
+            OpenSearchSuggestion(suggestion);
+        }
+    }
+
+    private void SearchSuggestionItem_Tapped(object sender, TappedRoutedEventArgs e)
+    {
+        if (sender is FrameworkElement element && element.DataContext is SearchSuggestion suggestion)
+        {
+            e.Handled = true;
+            OpenSearchSuggestion(suggestion);
+        }
+    }
+
     private void CloseNavigation(object sender, TappedRoutedEventArgs e)
     {
         ViewModel.CloseNavigationCommand.Execute(null);
@@ -165,9 +208,9 @@ private void SearchBox_TextChanged(AutoSuggestBox sender, AutoSuggestBoxTextChan
 
     private void SearchBox_QuerySubmitted(AutoSuggestBox sender, AutoSuggestBoxQuerySubmittedEventArgs args)
     {
-        if (_ignoreNextQuerySubmitted)
+        if (_ignoreQuerySubmittedCount > 0)
         {
-            _ignoreNextQuerySubmitted = false;
+            _ignoreQuerySubmittedCount--;
             return;
         }
 
@@ -180,47 +223,74 @@ private void SearchBox_QuerySubmitted(AutoSuggestBox sender, AutoSuggestBoxQuery
         ViewModel.Search.SubmitQuery(args.QueryText);
     }
 
-    private void SearchBox_SuggestionChosen(AutoSuggestBox sender, AutoSuggestBoxSuggestionChosenEventArgs args)
+    private void OpenSearchSuggestion(SearchSuggestion suggestion)
     {
-        if (args.SelectedItem is SearchSuggestion suggestion)
-        {
-            OpenSearchSuggestion(suggestion);
-        }
+        _ignoreQuerySubmittedCount = 1;
+        ViewModel.Search.SelectSuggestion(suggestion);
     }
 
-    private void OpenSearchSuggestion(SearchSuggestion suggestion)
+    private void ClearSearchField()
     {
-        _ignoreNextQuerySubmitted = true;
+        if (string.IsNullOrEmpty(ViewModel.Search.Query) && string.IsNullOrEmpty(SearchBox.Text))
+        {
+            return;
+        }
 
         _suppressSearchTextSync = true;
         try
         {
+            ViewModel.Search.ClearQuery();
             SearchBox.Text = string.Empty;
-            ViewModel.Search.SelectSuggestion(suggestion);
         }
         finally
         {
             _suppressSearchTextSync = false;
         }
     }
 
-    private void ClearSearchField()
+    private bool IsSearchSuggestionsActive()
     {
-        if (string.IsNullOrEmpty(ViewModel.Search.Query) && string.IsNullOrEmpty(SearchBox.Text))
+        if (ViewModel.Search.Suggestions.Count == 0)
         {
-            return;
+            return false;
         }
 
-        _suppressSearchTextSync = true;
-        try
+        return IsSearchBoxFocused() || TryGetFocusedSuggestion(out _);
+    }
+
+    private bool IsSearchBoxFocused()
+    {
+        for (DependencyObject? current = FocusManager.GetFocusedElement() as DependencyObject;
+             current is not null;
+             current = VisualTreeHelper.GetParent(current))
         {
-            ViewModel.Search.ClearQuery();
-            SearchBox.Text = string.Empty;
+            if (current == SearchBox)
+            {
+                return true;
+            }
         }
-        finally
+
+        return false;
+    }
+
+    private static bool TryGetFocusedSuggestion([NotNullWhen(true)] out SearchSuggestion? suggestion)
+    {
+        suggestion = null;
+        if (FocusManager.GetFocusedElement() is not DependencyObject focused)
         {
-            _suppressSearchTextSync = false;
+            return false;
         }
+
+        for (DependencyObject? current = focused; current is not null; current = VisualTreeHelper.GetParent(current))
+        {
+            if (current is FrameworkElement { DataContext: SearchSuggestion context })
+            {
+                suggestion = context;
+                return true;
+            }
+        }
+
+        return false;
     }
 
     internal sealed record Parameters(Action DeferredNavigationAction);