allow progress bar customisation via plugin

Author: jjw24

Flow.Launcher.Plugin/Result.cs

@@ -198,6 +198,15 @@ public ValueTask<bool> ExecuteAsync(ActionContext context)
             return AsyncAction?.Invoke(context) ?? ValueTask.FromResult(Action?.Invoke(context) ?? false);
         }
 
+        /// <summary>
+        /// Progress bar display. Providing an int value between 0-100 will trigger the progress bar to be displayed on the result
+        /// </summary>
         public int? ProgressBar { get; set; }
+
+        /// <summary>
+        /// Optionally set the color of the progress bar
+        /// </summary>
+        /// <default>#26a0da (blue)</default>
+        public string ProgressBarColor { get; set; } = "#26a0da";
     }
 }

Flow.Launcher/Converters/ProgressForegroundConverter.cs

@@ -46,7 +46,6 @@
                         <Grid.Resources>
                             <converter:HighlightTextConverter x:Key="HighlightTextConverter" />
                             <converter:OrdinalConverter x:Key="OrdinalConverter" />
-                            <converter:ProgressForegroundConverter x:Key="ProgressForegroundConverter" />
                             <converter:OpenResultHotkeyVisibilityConverter x:Key="OpenResultHotkeyVisibilityConverter" />
                         </Grid.Resources>
                         <Grid.ColumnDefinitions>
@@ -114,7 +113,7 @@
                             </Grid.RowDefinitions>
                             <ProgressBar
                                 x:Name="progressbarResult"
-                                Foreground="{Binding RelativeSource={RelativeSource Mode=Self}, Path=Value, Converter={StaticResource ProgressForegroundConverter}}"
+                                Foreground="{Binding Result.ProgressBarColor}"
                                 Style="{DynamicResource ProgressBarResult}"
                                 Value="{Binding Result.ProgressBar}" />
                             <TextBlock

Flow.Launcher/ResultListBox.xaml

@@ -77,12 +77,53 @@ internal static Result CreateFolderResult(string title, string subtitle, string
             };
         }
 
+        internal static Result CreateDriveSpaceDisplayResult(string path, bool windowsIndexed = false)
+        {
+            var progressBarColor = "#26a0da";
+            int? progressValue = null;
+            var title = string.Empty; // hide title when use progress bar,
+            var driveLetter = path.Substring(0, 1).ToUpper();
+            var driveName = driveLetter + ":\\";
+            DriveInfo drv = new DriveInfo(driveLetter);
+            var subtitle = toReadableSize(drv.AvailableFreeSpace, 2) + " free of " + toReadableSize(drv.TotalSize, 2);
+            double UsingSize = (Convert.ToDouble(drv.TotalSize) - Convert.ToDouble(drv.AvailableFreeSpace)) / Convert.ToDouble(drv.TotalSize) * 100;
+
+            progressValue = Convert.ToInt32(UsingSize);
+
+            if (progressValue >= 90)
+                progressBarColor = "#da2626";
+
+            return new Result
+            {
+                Title = title,
+                SubTitle = subtitle,
+                AutoCompleteText = GetPathWithActionKeyword(path, ResultType.Folder),
+                IcoPath = path,
+                Score = 500,
+                ProgressBar = progressValue,
+                ProgressBarColor = progressBarColor,
+                Action = c =>
+                {
+                    Context.API.OpenDirectory(path);
+                    return true;
+                },
+                TitleToolTip = path,
+                SubTitleToolTip = path,
+                ContextData = new SearchResult
+                {
+                    Type = ResultType.Folder,
+                    FullPath = path,
+                    ShowIndexState = true,
+                    WindowsIndexed = windowsIndexed
+                }
+            };
+        }
+
         private static string toReadableSize(long pDrvSize, int pi)
         {
             int mok = 0;
             double drvSize = pDrvSize;
             string Space = "Byte";
-            string returnStr = "";
 
             while (drvSize > 1024.0)
             {
@@ -91,25 +132,33 @@ private static string toReadableSize(long pDrvSize, int pi)
             }
 
             if (mok == 1)
-                Space =  "KB";
+                Space = "KB";
             else if (mok == 2)
                 Space = " MB";
             else if (mok == 3)
                 Space = " GB";
             else if (mok == 4)
                 Space = " TB";
 
+            var returnStr = string.Format("{0}{1}", Convert.ToInt32(drvSize), Space);
             if (mok != 0)
-                if (pi == 1)
-                    returnStr = string.Format("{0:F1}{1}", drvSize, Space);
-                else if (pi == 2)
-                    returnStr = string.Format("{0:F2}{1}", drvSize, Space);
-                else if (pi == 3)
-                    returnStr = string.Format("{0:F3}{1}", drvSize, Space);
-                else
-                    returnStr = string.Format("{0}{1}", Convert.ToInt32(drvSize), Space);
-            else
-                returnStr = string.Format("{0}{1}", Convert.ToInt32(drvSize), Space);
+            {
+                switch (pi)
+                {
+                    case 1:
+                        returnStr = string.Format("{0:F1}{1}", drvSize, Space);
+                        break;
+                    case 2:
+                        returnStr = string.Format("{0:F2}{1}", drvSize, Space);
+                        break;
+                    case 3:
+                        returnStr = string.Format("{0:F3}{1}", drvSize, Space);
+                        break;
+                    default:
+                        returnStr = string.Format("{0}{1}", Convert.ToInt32(drvSize), Space);
+                        break;
+                }
+            }
 
             return returnStr;
         }
@@ -123,28 +172,19 @@ internal static Result CreateOpenCurrentFolderResult(string path, bool windowsIn
                 Path.DirectorySeparatorChar
             }, StringSplitOptions.None).Last();
 
-            var title = "Open current directory";
-
-            if (retrievedDirectoryPath != path)
-                title = "Open " + folderName;
-
-            var subtitleFolderName = folderName;
-            var subtitle = $"Use > to search within {subtitleFolderName}, " +
-                           $"* to search for file extensions or >* to combine both searches.";
-
-            int? progressBar = null;
             if (retrievedDirectoryPath.EndsWith(":\\"))
             {
-                title = ""; // hide title when use progress bar,
                 var driveLetter = path.Substring(0, 1).ToUpper();
                 folderName = driveLetter + " drive";
-                var driveName = driveLetter + ":\\";
-                DriveInfo drv = new DriveInfo(driveLetter);
-                subtitle = toReadableSize(drv.AvailableFreeSpace, 2) + " free of " + toReadableSize(drv.TotalSize, 2);
-                double UsingSize = ((Convert.ToDouble(drv.TotalSize) - Convert.ToDouble(drv.AvailableFreeSpace)) / Convert.ToDouble(drv.TotalSize) * 100);
-                progressBar = Convert.ToInt32(UsingSize);
             }
 
+            var title = "Open current directory";
+
+            if (retrievedDirectoryPath != path)
+                title = "Open " + folderName;
+
+
+            var subtitleFolderName = folderName;
 
             // ie. max characters can be displayed without subtitle cutting off: "Program Files (x86)"
             if (folderName.Length > 19)
@@ -153,11 +193,11 @@ internal static Result CreateOpenCurrentFolderResult(string path, bool windowsIn
             return new Result
             {
                 Title = title,
-                SubTitle = subtitle,
+                SubTitle = $"Use > to search within {subtitleFolderName}, " +
+                           $"* to search for file extensions or >* to combine both searches.",
                 AutoCompleteText = GetPathWithActionKeyword(retrievedDirectoryPath, ResultType.Folder),
                 IcoPath = retrievedDirectoryPath,
                 Score = 500,
-                ProgressBar = progressBar,
                 Action = c =>
                 {
                     Context.API.OpenDirectory(retrievedDirectoryPath);

Plugins/Flow.Launcher.Plugin.Explorer/Search/ResultManager.cs

@@ -123,7 +123,14 @@ public async Task<List<Result>> PathSearchAsync(Query query, CancellationToken t
 
             var useIndexSearch = UseWindowsIndexForDirectorySearch(locationPath);
 
-            results.Add(ResultManager.CreateOpenCurrentFolderResult(locationPath, useIndexSearch));
+            if (locationPath.EndsWith(":\\"))
+            {
+                results.Add(ResultManager.CreateDriveSpaceDisplayResult(locationPath, useIndexSearch));
+            }
+            else
+            {
+                results.Add(ResultManager.CreateOpenCurrentFolderResult(locationPath, useIndexSearch));
+            }
 
             token.ThrowIfCancellationRequested();