Merge pull request #400 from immichFrame/dev.3rob3.progressbar

add progressbar setting

Author: JW-CH

ImmichFrame.Core/Interfaces/IServerSettings.cs

@@ -39,6 +39,7 @@ public interface IGeneralSettings
         public int RenewImagesDuration { get; }
         public bool ShowClock { get; }
         public string? ClockFormat { get; }
+        public bool ShowProgressBar { get; }
         public bool ShowPhotoDate { get; }
         public string? PhotoDateFormat { get; }
         public bool ShowImageDesc { get; }

ImmichFrame.WebApi.Tests/Resources/TestV1.json

@@ -32,6 +32,7 @@
     "RefreshAlbumPeopleInterval": 7,
     "ShowClock": true,
     "ClockFormat": "ClockFormat_TEST",
+    "ShowProgressBar": true,
     "ShowPhotoDate": true,
     "PhotoDateFormat": "PhotoDateFormat_TEST",
     "ShowImageDesc": true,

ImmichFrame.WebApi.Tests/Resources/TestV2.json

@@ -19,6 +19,7 @@
     "TransitionDuration": 7.7,
     "ShowClock": true,
     "ClockFormat": "ClockFormat_TEST",
+    "ShowProgressBar": true,
     "ShowPhotoDate": true,
     "ShowImageDesc": true,
     "ShowPeopleDesc": true,

ImmichFrame.WebApi/Helpers/Config/ServerSettingsV1.cs

@@ -35,6 +35,7 @@ public class ServerSettingsV1 : IConfigSettable
     public double TransitionDuration { get; set; } = 1;
     public bool ShowClock { get; set; } = true;
     public string? ClockFormat { get; set; } = "hh:mm";
+    public bool ShowProgressBar { get; set; } = true;
     public bool ShowPhotoDate { get; set; } = true;
     public string? PhotoDateFormat { get; set; } = "MM/dd/yyyy";
     public bool ShowImageDesc { get; set; } = true;
@@ -97,6 +98,7 @@ class GeneralSettingsV1Adapter(ServerSettingsV1 _delegate) : IGeneralSettings
         public int RenewImagesDuration => _delegate.RenewImagesDuration;
         public bool ShowClock => _delegate.ShowClock;
         public string? ClockFormat => _delegate.ClockFormat;
+        public bool ShowProgressBar => _delegate.ShowProgressBar;
         public bool ShowPhotoDate => _delegate.ShowPhotoDate;
         public string? PhotoDateFormat => _delegate.PhotoDateFormat;
         public bool ShowImageDesc => _delegate.ShowImageDesc;

ImmichFrame.WebApi/Models/ServerSettings.cs

@@ -26,6 +26,7 @@ public class GeneralSettings : IGeneralSettings, IConfigSettable
     public double TransitionDuration { get; set; } = 1;
     public bool ShowClock { get; set; } = true;
     public string? ClockFormat { get; set; } = "hh:mm";
+    public bool ShowProgressBar { get; set; } = true;
     public bool ShowPhotoDate { get; set; } = true;
     public bool ShowImageDesc { get; set; } = true;
     public bool ShowPeopleDesc { get; set; } = true;

Install_Web.md

@@ -61,6 +61,7 @@ services:
       # RefreshAlbumPeopleInterval: "12"
       # ShowClock: "true"
       # ClockFormat: "hh:mm"
+      # ShowProgressBar: "true"
       # ShowPhotoDate: "true"
       # PhotoDateFormat: "yyyy-MM-dd"
       # ShowImageDesc: "true"

docker/Settings.example.json

@@ -17,6 +17,7 @@
     "TransitionDuration": 2,
     "ShowClock": true,
     "ClockFormat": "hh:mm",
+    "ShowProgressBar": true,
     "ShowPhotoDate": true,
     "ShowImageDesc": true,
     "ShowPeopleDesc": true,

docker/example.env

@@ -22,6 +22,7 @@ ApiKey=KEY
 # RefreshAlbumPeopleInterval=12
 # ShowClock=true
 # ClockFormat=hh:mm
+# ShowProgressBar=true
 # ShowPhotoDate=true
 # PhotoDateFormat=yyyy-MM-dd
 # ShowImageDesc=true

docs/docs/getting-started/configuration.md

@@ -49,6 +49,8 @@ Defaults are below, only one account with `ImmichServerUrl` and `ApiKey` are req
     "ShowClock": true, // boolean
     // Time format
     "ClockFormat": "hh:mm", // string
+    // Displays the progress bar.
+    "ShowProgressBar": true, // boolean
     // Displays the date of the current image. 
     "ShowPhotoDate": true, // boolean
     // Displays the description of the current image.

immichFrame.Web/src/lib/components/home-page/home-page.svelte

@@ -405,7 +405,7 @@
 		<ProgressBar
 			autoplay
 			duration={$configStore.interval}
-			hidden={false}
+			hidden={!$configStore.showProgressBar}
 			location={ProgressBarLocation.Bottom}
 			bind:this={progressBar}
 			bind:status={progressBarStatus}