Feature: Added a filter header (#17268)

Signed-off-by: Yair <[email protected]>
Co-authored-by: 0x5BFA <[email protected]>

Author: yaira2

src/Files.App/Actions/Show/ToggleFilterHeaderAction.cs

@@ -0,0 +1,50 @@
+// Copyright (c) Files Community
+// Licensed under the MIT License.
+
+using CommunityToolkit.WinUI;
+using Microsoft.UI.Xaml;
+using Microsoft.UI.Xaml.Controls;
+
+namespace Files.App.Actions
+{
+	internal sealed partial class ToggleFilterHeaderAction : ObservableObject, IToggleAction
+	{
+		private readonly IGeneralSettingsService generalSettingsService = Ioc.Default.GetRequiredService<IGeneralSettingsService>();
+
+		public string Label
+			=> Strings.ToggleFilterHeader.GetLocalizedResource();
+
+		public string Description
+			=> Strings.ToggleFilterHeaderDescription.GetLocalizedResource();
+
+		public RichGlyph Glyph
+			=> new(themedIconStyle: "App.ThemedIcons.Filter");
+
+		public bool IsOn
+			=> generalSettingsService.ShowFilterHeader;
+
+		public ToggleFilterHeaderAction()
+		{
+			generalSettingsService.PropertyChanged += GeneralSettingsService_PropertyChanged;
+		}
+
+		public Task ExecuteAsync(object? parameter = null)
+		{
+			generalSettingsService.ShowFilterHeader = !IsOn;
+
+			if (IsOn)
+			{
+				var filterTextBox = (MainWindow.Instance.Content as Frame)?.FindDescendant("FilterTextBox") as AutoSuggestBox;
+				filterTextBox?.Focus(FocusState.Programmatic);
+			}
+
+			return Task.CompletedTask;
+		}
+
+		private void GeneralSettingsService_PropertyChanged(object? sender, PropertyChangedEventArgs e)
+		{
+			if (e.PropertyName is nameof(GeneralSettingsService.ShowFilterHeader))
+				OnPropertyChanged(nameof(IsOn));
+		}
+	}
+}

src/Files.App/Data/Commands/Manager/CommandCodes.cs

@@ -27,6 +27,7 @@ public enum CommandCodes
 		ToggleInfoPane,
 		ToggleToolbar,
 		ToggleShelfPane,
+		ToggleFilterHeader,
 
 		// File System
 		CopyItem,

src/Files.App/Data/Commands/Manager/CommandManager.cs

@@ -58,6 +58,7 @@ public IRichCommand this[HotKey hotKey]
 		public IRichCommand ToggleInfoPane => commands[CommandCodes.ToggleInfoPane];
 		public IRichCommand ToggleToolbar => commands[CommandCodes.ToggleToolbar];
 		public IRichCommand ToggleShelfPane => commands[CommandCodes.ToggleShelfPane];
+		public IRichCommand ToggleFilterHeader => commands[CommandCodes.ToggleFilterHeader];
 		public IRichCommand SelectAll => commands[CommandCodes.SelectAll];
 		public IRichCommand InvertSelection => commands[CommandCodes.InvertSelection];
 		public IRichCommand ClearSelection => commands[CommandCodes.ClearSelection];
@@ -264,6 +265,7 @@ public IEnumerator<IRichCommand> GetEnumerator() =>
 			[CommandCodes.ToggleInfoPane] = new ToggleInfoPaneAction(),
 			[CommandCodes.ToggleToolbar] = new ToggleToolbarAction(),
 			[CommandCodes.ToggleShelfPane] = new ToggleShelfPaneAction(),
+			[CommandCodes.ToggleFilterHeader] = new ToggleFilterHeaderAction(),
 			[CommandCodes.SelectAll] = new SelectAllAction(),
 			[CommandCodes.InvertSelection] = new InvertSelectionAction(),
 			[CommandCodes.ClearSelection] = new ClearSelectionAction(),

src/Files.App/Data/Commands/Manager/ICommandManager.cs

@@ -32,6 +32,7 @@ public interface ICommandManager : IEnumerable<IRichCommand>
 		IRichCommand ToggleInfoPane { get; }
 		IRichCommand ToggleToolbar { get; }
 		IRichCommand ToggleShelfPane { get; }
+		IRichCommand ToggleFilterHeader { get; }
 
 		IRichCommand CopyItem { get; }
 		IRichCommand CopyItemPath { get; }

src/Files.App/Data/Contracts/IGeneralSettingsService.cs

@@ -50,6 +50,11 @@ public interface IGeneralSettingsService : IBaseSettingsService, INotifyProperty
 		/// </summary>
 		List<string> PathHistoryList { get; set; }
 
+		/// <summary>
+		/// A list containing previous search queries.
+		/// </summary>
+		List<string> PreviousSearchQueriesList { get; set; }
+
 		/// <summary>
 		/// Gets or sets a value indicating which date and time format to use.
 		/// </summary>
@@ -295,6 +300,11 @@ public interface IGeneralSettingsService : IBaseSettingsService, INotifyProperty
 		/// </summary>
 		bool ShowShelfPane { get; set; }
 
+		/// <summary>
+		/// Gets or sets a value whether the filter header should be displayed.
+		/// </summary>
+		bool ShowFilterHeader { get; set; }
+
 		/// <summary>
 		/// Gets or sets a value indicating whether or not to enable the Omnibar.
 		/// </summary>

src/Files.App/Services/Settings/GeneralSettingsService.cs

@@ -65,6 +65,12 @@ public List<string> PathHistoryList
 			set => Set(value);
 		}
 
+		public List<string> PreviousSearchQueriesList
+		{
+			get => Get<List<string>>(null);
+			set => Set(value);
+		}
+
 		public DateTimeFormats DateTimeFormat
 		{
 			get => Get(DateTimeFormats.Application);
@@ -363,6 +369,12 @@ public bool ShowShelfPane
 			set => Set(value);
 		}
 
+		public bool ShowFilterHeader
+		{
+			get => Get(false);
+			set => Set(value);
+		}
+
 		public bool EnableOmnibar
 		{
 			get => Get(false);

src/Files.App/Services/Settings/UserSettingsService.cs

@@ -74,6 +74,7 @@ public override object ExportSettings()
 			export.Remove(nameof(GeneralSettingsService.LastSessionTabList));
 			export.Remove(nameof(GeneralSettingsService.LastCrashedTabList));
 			export.Remove(nameof(GeneralSettingsService.PathHistoryList));
+			export.Remove(nameof(GeneralSettingsService.PreviousSearchQueriesList));
 
 			return JsonSettingsSerializer.SerializeToJson(export);
 		}

src/Files.App/Strings/en-US/Resources.resw

@@ -1097,6 +1097,12 @@
   <data name="ToggleToolbarDescription" xml:space="preserve">
     <value>Toggle visibility of the toolbar</value>
   </data>
+  <data name="ToggleFilterHeader" xml:space="preserve">
+    <value>Toggle filter header</value>
+  </data>
+  <data name="ToggleFilterHeaderDescription" xml:space="preserve">
+    <value>Toggle visibility of the filter header</value>
+  </data>
   <data name="DetailsPanePreviewNotAvaliableText" xml:space="preserve">
     <value>No preview available</value>
   </data>
@@ -4261,4 +4267,10 @@
   <data name="SeeMore" xml:space="preserve">
     <value>See more</value>
   </data>
+  <data name="FilteringFor" xml:space="preserve">
+    <value>Filtering for</value>
+  </data>
+  <data name="Filename" xml:space="preserve">
+    <value>Filename</value>
+  </data>
 </root>

src/Files.App/UserControls/NavigationToolbar.xaml

@@ -30,6 +30,10 @@
 			<converters:NullToVisibilityCollapsedConverter x:Key="NullToVisibilityCollapsedConverter" />
 			<converters1:BoolNegationConverter x:Key="BoolNegationConverter" />
 			<converters:VisibilityInvertConverter x:Key="VisibilityInvertConverter" />
+			<converters1:BoolToObjectConverter
+				x:Key="SearchSuggestionGlyphConverter"
+				FalseValue="&#xE7C3;"
+				TrueValue="&#xE81C;" />
 
 			<ResourceDictionary.MergedDictionaries>
 				<ResourceDictionary Source="ms-appx:///UserControls/KeyboardShortcut/KeyboardShortcut.xaml" />

src/Files.App/UserControls/NavigationToolbar.xaml.cs

@@ -316,7 +316,22 @@ await DialogDisplayHelper.ShowDialogAsync(Strings.InvalidCommand.GetLocalizedRes
 			// Search mode
 			else if (mode == OmnibarSearchMode)
 			{
-				ContentPageContext.ShellPage?.SubmitSearch(args.Text);
+				var shellPage = ContentPageContext.ShellPage;
+
+				if (args.Item is SuggestionModel item && !string.IsNullOrWhiteSpace(item.ItemPath) && shellPage is not null)
+					await NavigationHelpers.OpenPath(item.ItemPath, shellPage);
+				else
+				{
+					var searchQuery = args.Item is SuggestionModel x && !string.IsNullOrWhiteSpace(x.Name)
+						? x.Name
+						: args.Text;
+
+					shellPage?.SubmitSearch(searchQuery); // use the resolved shellPage for consistency
+					ViewModel.SaveSearchQueryToList(searchQuery);
+				}
+
+				(MainPageViewModel.SelectedTabItem?.TabItemContent as Control)?.Focus(FocusState.Programmatic);
+				return;
 			}
 		}
 
@@ -338,6 +353,7 @@ await DispatcherQueue.EnqueueOrInvokeAsync(() =>
 			}
 			else if (Omnibar.CurrentSelectedMode == OmnibarSearchMode)
 			{
+				await ViewModel.PopulateOmnibarSuggestionsForSearchMode();
 			}
 		}
 
@@ -456,7 +472,12 @@ await DispatcherQueue.EnqueueOrInvokeAsync(() =>
 			}
 			else if (e.NewMode == OmnibarSearchMode)
 			{
+				if (!ViewModel.InstanceViewModel.IsPageTypeSearchResults)
+					ViewModel.OmnibarSearchModeText = string.Empty;
+				else
+					ViewModel.OmnibarSearchModeText = ViewModel.InstanceViewModel.CurrentSearchQuery;
 
+				await ViewModel.PopulateOmnibarSuggestionsForSearchMode();
 			}
 		}
 
@@ -486,7 +507,7 @@ await DispatcherQueue.EnqueueOrInvokeAsync(() =>
 				}
 				else if (Omnibar.CurrentSelectedMode == OmnibarSearchMode)
 				{
-
+					await ViewModel.PopulateOmnibarSuggestionsForSearchMode();
 				}
 			}
 		}