Added populating suggestions for Path mode in Omnibar

Author: 0x5bfa

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

@@ -13,10 +13,18 @@ public partial class Omnibar
 		[GeneratedDependencyProperty]
 		public partial OmnibarMode? CurrentSelectedMode { get; set; }
 
+		[GeneratedDependencyProperty]
+		public partial string? CurrentSelectedModeName { get; set; }
+
 		[GeneratedDependencyProperty]
 		public partial Thickness AutoSuggestBoxPadding { get; set; }
 
 		[GeneratedDependencyProperty]
 		public partial bool IsFocused { get; set; }
+
+		partial void OnCurrentSelectedModeChanged(OmnibarMode? newValue)
+		{
+			CurrentSelectedModeName = newValue?.ModeName;
+		}
 	}
 }

src/Files.App/Data/Items/NavigationBarSuggestionItem.cs

@@ -3,6 +3,7 @@
 
 namespace Files.App.Data.Items
 {
+	[Obsolete("Remove once Omnibar goes out of experimental.")]
 	public sealed partial class NavigationBarSuggestionItem : ObservableObject
 	{
 		private string? _Text;

src/Files.App/Data/Models/OmnibarPathModeSuggestionModel.cs

@@ -0,0 +1,7 @@
+// Copyright (c) Files Community
+// Licensed under the MIT License.
+
+namespace Files.App.Data.Models
+{
+	internal record OmnibarPathModeSuggestionModel(string Path, string DisplayName);
+}

src/Files.App/UserControls/NavigationToolbar.xaml

@@ -10,6 +10,7 @@
 	xmlns:converters1="using:CommunityToolkit.WinUI.Converters"
 	xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
 	xmlns:dataitems="using:Files.App.Data.Items"
+	xmlns:datamodels="using:Files.App.Data.Models"
 	xmlns:helpers="using:Files.App.Helpers"
 	xmlns:items="using:Files.App.Data.Items"
 	xmlns:keyboard="using:Files.App.UserControls.KeyboardShortcut"
@@ -339,14 +340,16 @@
 			x:Name="Omnibar"
 			Grid.Column="1"
 			x:Load="{x:Bind ViewModel.EnableOmnibar, Mode=OneWay}"
+			CurrentSelectedModeName="{x:Bind ViewModel.OmnibarCurrentSelectedModeName, Mode=TwoWay}"
 			IsFocused="{x:Bind ViewModel.IsOmnibarFocused, Mode=TwoWay}">
 
 			<controls:OmnibarMode
 				IconOnActive="{controls:ThemedIconMarkup Style={StaticResource App.ThemedIcons.Omnibar.Path}, IsFilled=True}"
 				IconOnInactive="{controls:ThemedIconMarkup Style={StaticResource App.ThemedIcons.Omnibar.Path}, IconType=Outline}"
 				IsDefault="True"
-				ModeName="{helpers:ResourceString Name=Path}"
+				ModeName="Path"
 				PlaceholderText="{helpers:ResourceString Name=OmnibarPathModeTextPlaceholder}"
+				SuggestionItemsSource="{x:Bind ViewModel.PathModeSuggestionItems, Mode=OneWay}"
 				Text="{x:Bind ViewModel.OmnibarPathModeText, Mode=OneWay}">
 				<controls:OmnibarMode.ContentOnInactive>
 					<controls:BreadcrumbBar x:Name="NewBreadcrumbBar" ItemsSource="{x:Bind ViewModel.PathComponents, Mode=OneWay}">
@@ -363,6 +366,11 @@
 						</controls:BreadcrumbBar.ItemTemplate>
 					</controls:BreadcrumbBar>
 				</controls:OmnibarMode.ContentOnInactive>
+				<controls:OmnibarMode.SuggestionItemTemplate>
+					<DataTemplate x:DataType="datamodels:OmnibarPathModeSuggestionModel">
+						<TextBlock Text="{x:Bind DisplayName, Mode=OneWay}" />
+					</DataTemplate>
+				</controls:OmnibarMode.SuggestionItemTemplate>
 			</controls:OmnibarMode>
 
 			<controls:OmnibarMode

src/Files.App/ViewModels/UserControls/NavigationToolbarViewModel.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 using CommunityToolkit.WinUI;
+using Files.App.Controls;
 using Files.Shared.Helpers;
 using Microsoft.UI.Dispatching;
 using Microsoft.UI.Xaml;
@@ -21,6 +22,10 @@ public sealed partial class NavigationToolbarViewModel : ObservableObject, IAddr
 
 		private const int MaxSuggestionsCount = 10;
 
+		public const string OmnibarPathModeName = "Path";
+		public const string OmnibarPaletteModeName = "Palette";
+		public const string OmnibarSearchModeName = "Search";
+
 		// Dependency injections
 
 		private readonly IUserSettingsService UserSettingsService = Ioc.Default.GetRequiredService<IUserSettingsService>();
@@ -29,6 +34,7 @@ public sealed partial class NavigationToolbarViewModel : ObservableObject, IAddr
 		private readonly DrivesViewModel drivesViewModel = Ioc.Default.GetRequiredService<DrivesViewModel>();
 		private readonly IUpdateService UpdateService = Ioc.Default.GetRequiredService<IUpdateService>();
 		private readonly ICommandManager Commands = Ioc.Default.GetRequiredService<ICommandManager>();
+		private readonly IContentPageContext ContentPageContext = Ioc.Default.GetRequiredService<IContentPageContext>();
 
 		// Fields
 
@@ -62,6 +68,8 @@ public sealed partial class NavigationToolbarViewModel : ObservableObject, IAddr
 
 		public ObservableCollection<NavigationBarSuggestionItem> NavigationBarSuggestions { get; } = [];
 
+		internal ObservableCollection<OmnibarPathModeSuggestionModel> PathModeSuggestionItems { get; } = [];
+
 		public bool IsSingleItemOverride { get; set; }
 
 		public bool SearchHasFocus { get; private set; }
@@ -205,11 +213,28 @@ public  bool IsOmnibarFocused
 					if (value)
 					{
 						EditModeEnabled?.Invoke(this, EventArgs.Empty);
+
+						switch(OmnibarCurrentSelectedModeName)
+						{
+							case OmnibarPathModeName:
+								_ = PopulateOmnibarSuggestionsForPathMode();
+								break;
+							case OmnibarPaletteModeName:
+								break;
+							case OmnibarSearchModeName:
+								break;
+							default:
+								throw new ArgumentOutOfRangeException("");
+						}
+
 					}
 				}
 			}
 		}
 
+		private string _OmnibarCurrentSelectedModeName;
+		public string OmnibarCurrentSelectedModeName { get => _OmnibarCurrentSelectedModeName; set => SetProperty(ref _OmnibarCurrentSelectedModeName, value); }
+
 		private string _OmnibarPathModeText;
 		public string OmnibarPathModeText { get => _OmnibarPathModeText; set => SetProperty(ref _OmnibarPathModeText, value); }
 
@@ -892,7 +917,108 @@ private static async Task<bool> LaunchApplicationFromPath(string currentInput, s
 			);
 		}
 
-		public async Task SetAddressBarSuggestionsAsync(AutoSuggestBox sender, IShellPage shellpage)
+		public async Task PopulateOmnibarSuggestionsForPathMode()
+		{
+			var result = await SafetyExtensions.IgnoreExceptions(async () =>
+			{
+				List<OmnibarPathModeSuggestionModel>? newSuggestions = [];
+				var pathText = OmnibarPathModeText;
+
+				// If the current input is special, populate navigation history instead.
+				if (string.IsNullOrWhiteSpace(pathText) ||
+					pathText is "Home" or "ReleaseNotes" or "Settings")
+				{
+					// Load previously entered path
+					if (UserSettingsService.GeneralSettingsService.PathHistoryList is { } pathHistoryList)
+					{
+						newSuggestions.AddRange(pathHistoryList.Select(x => new OmnibarPathModeSuggestionModel(x, x)));
+					}
+				}
+				else
+				{
+					var isFtp = FtpHelpers.IsFtpPath(pathText);
+					pathText = NormalizePathInput(pathText, isFtp);
+					var expandedPath = StorageFileExtensions.GetResolvedPath(pathText, isFtp);
+					var folderPath = PathNormalization.GetParentDir(expandedPath) ?? expandedPath;
+					StorageFolderWithPath folder = await ContentPageContext.ShellPage.ShellViewModel.GetFolderWithPathFromPathAsync(folderPath);
+					if (folder is null)
+						return false;
+
+					var currPath = await folder.GetFoldersWithPathAsync(Path.GetFileName(expandedPath), MaxSuggestionsCount);
+					if (currPath.Count >= MaxSuggestionsCount)
+					{
+						newSuggestions.AddRange(currPath.Select(x => new OmnibarPathModeSuggestionModel(x.Path, x.Item.DisplayName)));
+					}
+					else if (currPath.Any())
+					{
+						var subPath = await currPath.First().GetFoldersWithPathAsync((uint)(MaxSuggestionsCount - currPath.Count));
+						newSuggestions.AddRange(currPath.Select(x => new OmnibarPathModeSuggestionModel(x.Path, x.Item.DisplayName)));
+						newSuggestions.AddRange(subPath.Select(x => new OmnibarPathModeSuggestionModel(x.Path, PathNormalization.Combine(currPath.First().Item.DisplayName, x.Item.DisplayName))));
+					}
+
+					// If there are no suggestions, show "No suggestions"
+					if (newSuggestions.Count is 0)
+					{
+						AddNoResultsItem();
+					}
+
+					// Check whether at least one item is in common between the old and the new suggestions
+					// since Omnibar suggestions popup becoming empty causes flickering
+					if (!PathModeSuggestionItems.IntersectBy(newSuggestions, x => x.DisplayName).Any())
+					{
+						// No items in common, update the list in-place
+						for (int index = 0; index < newSuggestions.Count; index++)
+						{
+							if (index < PathModeSuggestionItems.Count)
+							{
+								PathModeSuggestionItems[index] = newSuggestions[index];
+							}
+							else
+							{
+								PathModeSuggestionItems.Add(newSuggestions[index]);
+							}
+						}
+
+						while (PathModeSuggestionItems.Count > newSuggestions.Count)
+							PathModeSuggestionItems.RemoveAt(PathModeSuggestionItems.Count - 1);
+					}
+					else
+					{
+						// At least an element in common, show animation
+						foreach (var s in PathModeSuggestionItems.ExceptBy(newSuggestions, x => x.DisplayName).ToList())
+							PathModeSuggestionItems.Remove(s);
+
+						for (int index = 0; index < newSuggestions.Count; index++)
+						{
+							if (PathModeSuggestionItems.Count > index && PathModeSuggestionItems[index].DisplayName == newSuggestions[index].DisplayName)
+							{
+								PathModeSuggestionItems[index] = newSuggestions[index];
+							}
+							else
+								PathModeSuggestionItems.Insert(index, newSuggestions[index]);
+						}
+					}
+				}
+
+				return true;
+			});
+
+			if (!result)
+			{
+				AddNoResultsItem();
+			}
+
+			void AddNoResultsItem()
+			{
+				PathModeSuggestionItems.Clear();
+				PathModeSuggestionItems.Add(new(
+					ContentPageContext.ShellPage.ShellViewModel.WorkingDirectory,
+					Strings.NavigationToolbarVisiblePathNoResults.GetLocalizedResource()));
+			}
+		}
+
+		[Obsolete("Remove once Omnibar goes out of experimental.")]
+		public async Task SetLegacyAddressBarSuggestionsAsync(AutoSuggestBox sender, IShellPage shellpage)
 		{
 			if (sender.Text is not null && shellpage.ShellViewModel is not null)
 			{

src/Files.App/Views/Shells/BaseShellPage.cs

@@ -417,7 +417,7 @@ protected async void ShellPage_PathBoxItemDropped(object sender, PathBoxItemDrop
 
 		protected async void ShellPage_AddressBarTextEntered(object sender, AddressBarTextEnteredEventArgs e)
 		{
-			await ToolbarViewModel.SetAddressBarSuggestionsAsync(e.AddressBarTextField, this);
+			await ToolbarViewModel.SetLegacyAddressBarSuggestionsAsync(e.AddressBarTextField, this);
 		}
 
 		protected async void ShellPage_ToolbarPathItemLoaded(object sender, ToolbarPathItemLoadedEventArgs e)