Feature: Added an optional home button (#16122)

Author: yaira2

src/Files.App/Actions/Navigation/NavigateHomeAction.cs

@@ -0,0 +1,46 @@
+// Copyright (c) 2024 Files Community
+// Licensed under the MIT License. See the LICENSE.
+
+namespace Files.App.Actions
+{
+	internal sealed class NavigateHomeAction : ObservableObject, IAction
+	{
+		private readonly IContentPageContext context;
+
+		public string Label
+			=> "Home".GetLocalizedResource();
+
+		public string Description
+			=> "NavigateHomeDescription".GetLocalizedResource();
+
+		public RichGlyph Glyph
+			=> new("\uE80F");
+
+		public bool IsExecutable
+			=> context.PageType is not ContentPageTypes.Home;
+
+		public NavigateHomeAction()
+		{
+			context = Ioc.Default.GetRequiredService<IContentPageContext>();
+
+			context.PropertyChanged += Context_PropertyChanged;
+		}
+
+		public Task ExecuteAsync(object? parameter = null)
+		{
+			context.ShellPage!.NavigateHome();
+
+			return Task.CompletedTask;
+		}
+
+		private void Context_PropertyChanged(object? sender, PropertyChangedEventArgs e)
+		{
+			switch (e.PropertyName)
+			{
+				case nameof(IContentPageContext.PageType):
+					OnPropertyChanged(nameof(IsExecutable));
+					break;
+			}
+		}
+	}
+}

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

@@ -179,6 +179,7 @@ public enum CommandCodes
 		NavigateBack,
 		NavigateForward,
 		NavigateUp,
+		NavigateHome,
 
 		// Other
 		DuplicateCurrentTab,

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

@@ -175,6 +175,7 @@ public IRichCommand this[HotKey hotKey]
 		public IRichCommand NavigateBack => commands[CommandCodes.NavigateBack];
 		public IRichCommand NavigateForward => commands[CommandCodes.NavigateForward];
 		public IRichCommand NavigateUp => commands[CommandCodes.NavigateUp];
+		public IRichCommand NavigateHome => commands[CommandCodes.NavigateHome];
 		public IRichCommand DuplicateCurrentTab => commands[CommandCodes.DuplicateCurrentTab];
 		public IRichCommand DuplicateSelectedTab => commands[CommandCodes.DuplicateSelectedTab];
 		public IRichCommand CloseTabsToTheLeftCurrent => commands[CommandCodes.CloseTabsToTheLeftCurrent];
@@ -366,6 +367,7 @@ public IEnumerator<IRichCommand> GetEnumerator() =>
 			[CommandCodes.NavigateBack] = new NavigateBackAction(),
 			[CommandCodes.NavigateForward] = new NavigateForwardAction(),
 			[CommandCodes.NavigateUp] = new NavigateUpAction(),
+			[CommandCodes.NavigateHome] = new NavigateHomeAction(),
 			[CommandCodes.DuplicateCurrentTab] = new DuplicateCurrentTabAction(),
 			[CommandCodes.DuplicateSelectedTab] = new DuplicateSelectedTabAction(),
 			[CommandCodes.CloseTabsToTheLeftCurrent] = new CloseTabsToTheLeftCurrentAction(),

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

@@ -164,6 +164,7 @@ public interface ICommandManager : IEnumerable<IRichCommand>
 		IRichCommand NavigateBack { get; }
 		IRichCommand NavigateForward { get; }
 		IRichCommand NavigateUp { get; }
+		IRichCommand NavigateHome { get; }
 
 		IRichCommand DuplicateCurrentTab { get; }
 		IRichCommand DuplicateSelectedTab { get; }

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

@@ -106,5 +106,10 @@ public interface IAppearanceSettingsService : IBaseSettingsService, INotifyPrope
 		/// Gets or sets a value whether the tab actions button should be displayed.
 		/// </summary>
 		bool ShowTabActions { get; set; }
+
+		/// <summary>
+		/// Gets or sets a value whether the home button should be displayed.
+		/// </summary>
+		bool ShowHomeButton { get; set; }
 	}
 }

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

@@ -145,6 +145,13 @@ public bool ShowTabActions
 			set => Set(value);
 		}
 
+		/// <inheritdoc/>
+		public bool ShowHomeButton
+		{
+			get => Get(false);
+			set => Set(value);
+		}
+
 		protected override void RaiseOnSettingChangedEvent(object sender, SettingChangedEventArgs e)
 		{
 			base.RaiseOnSettingChangedEvent(sender, e);

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

@@ -3935,4 +3935,10 @@
   <data name="CPUThreads" xml:space="preserve">
     <value>CPU threads</value>
   </data>
+  <data name="NavigateHomeDescription" xml:space="preserve">
+    <value>Navigate to the home page</value>
+  </data>
+  <data name="ShowHomeButton" xml:space="preserve">
+    <value>Show home button in the toolbar</value>
+  </data>
 </root>

src/Files.App/UserControls/AddressToolbar.xaml

@@ -265,7 +265,6 @@
 
 				<Button
 					x:Name="Back"
-					x:FieldModifier="public"
 					AccessKey="B"
 					AccessKeyInvoked="Button_AccessKeyInvoked"
 					AutomationProperties.FullDescription="{x:Bind ViewModel.Commands.NavigateBack.Description, Mode=OneWay}"
@@ -295,7 +294,6 @@
 
 				<Button
 					x:Name="Forward"
-					x:FieldModifier="public"
 					AccessKey="F"
 					AccessKeyInvoked="Button_AccessKeyInvoked"
 					AutomationProperties.FullDescription="{x:Bind ViewModel.Commands.NavigateForward.Description, Mode=OneWay}"
@@ -325,7 +323,6 @@
 
 				<Button
 					x:Name="Up"
-					x:FieldModifier="public"
 					AccessKey="U"
 					AccessKeyInvoked="Button_AccessKeyInvoked"
 					AutomationProperties.FullDescription="{x:Bind ViewModel.Commands.NavigateUp.Description, Mode=OneWay}"
@@ -339,7 +336,6 @@
 
 				<Button
 					x:Name="Refresh"
-					x:FieldModifier="public"
 					AccessKey="R"
 					AccessKeyInvoked="Button_AccessKeyInvoked"
 					AutomationProperties.Name="{x:Bind Commands.RefreshItems.Label}"
@@ -349,6 +345,19 @@
 					ToolTipService.ToolTip="{x:Bind Commands.RefreshItems.LabelWithHotKey, Mode=OneWay}">
 					<FontIcon FontSize="14" Glyph="{x:Bind Commands.RefreshItems.Glyph.BaseGlyph}" />
 				</Button>
+
+				<Button
+					x:Name="HomeButton"
+					x:Load="{x:Bind ViewModel.ShowHomeButton, Mode=OneWay}"
+					AccessKey="H"
+					AccessKeyInvoked="Button_AccessKeyInvoked"
+					AutomationProperties.Name="{x:Bind Commands.NavigateHome.Label}"
+					Command="{x:Bind Commands.NavigateHome, Mode=OneWay}"
+					IsEnabled="{x:Bind Commands.NavigateHome.IsExecutable, Mode=OneWay}"
+					Style="{StaticResource AddressToolbarButtonStyle}"
+					ToolTipService.ToolTip="{x:Bind Commands.NavigateHome.LabelWithHotKey, Mode=OneWay}">
+					<FontIcon FontSize="14" Glyph="{x:Bind Commands.NavigateHome.Glyph.BaseGlyph}" />
+				</Button>
 			</StackPanel>
 
 			<!--  Path Box  -->

src/Files.App/ViewModels/Settings/AppearanceViewModel.cs

@@ -301,5 +301,19 @@ public bool ShowTabActions
 				}
 			}
 		}
+
+		public bool ShowHomeButton
+		{
+			get => UserSettingsService.AppearanceSettingsService.ShowHomeButton;
+			set
+			{
+				if (value != UserSettingsService.AppearanceSettingsService.ShowHomeButton)
+				{
+					UserSettingsService.AppearanceSettingsService.ShowHomeButton = value;
+
+					OnPropertyChanged();
+				}
+			}
+		}
 	}
 }

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

@@ -21,6 +21,7 @@ public sealed class AddressToolbarViewModel : ObservableObject, IAddressToolbarV
 		private const int MAX_SUGGESTIONS = 10;
 
 		private IUserSettingsService UserSettingsService { get; } = Ioc.Default.GetRequiredService<IUserSettingsService>();
+		private IAppearanceSettingsService AppearanceSettingsService { get; } = Ioc.Default.GetRequiredService<IAppearanceSettingsService>();
 
 		private readonly IDialogService _dialogService = Ioc.Default.GetRequiredService<IDialogService>();
 
@@ -169,6 +170,9 @@ public string? PathText
 			}
 		}
 
+		public bool ShowHomeButton
+			=> AppearanceSettingsService.ShowHomeButton;
+
 		public ObservableCollection<NavigationBarSuggestionItem> NavigationBarSuggestions = [];
 
 		private CurrentInstanceViewModel instanceViewModel;
@@ -213,6 +217,16 @@ public AddressToolbarViewModel()
 			SearchBox.Escaped += SearchRegion_Escaped;
 			UserSettingsService.OnSettingChangedEvent += UserSettingsService_OnSettingChangedEvent;
 			UpdateService.PropertyChanged += UpdateService_OnPropertyChanged;
+
+			AppearanceSettingsService.PropertyChanged += (s, e) =>
+			{
+				switch (e.PropertyName)
+				{
+					case nameof(AppearanceSettingsService.ShowHomeButton):
+						OnPropertyChanged(nameof(ShowHomeButton));
+						break;
+				}
+			};
 		}
 
 		private async void UpdateService_OnPropertyChanged(object? sender, PropertyChangedEventArgs e)