Add BadgePath & BadgeIcon property

Author: Jack251970

Flow.Launcher.Plugin/Result.cs

@@ -12,12 +12,19 @@ namespace Flow.Launcher.Plugin
     /// </summary>
     public class Result
     {
+        /// <summary>
+        /// Maximum score. This can be useful when set one result to the top by default. This is the score for the results set to the topmost by users.
+        /// </summary>
+        public const int MaxScore = int.MaxValue;
+
         private string _pluginDirectory;
 
         private string _icoPath;
 
         private string _copyText = string.Empty;
 
+        private string _badgePath;
+
         /// <summary>
         /// The title of the result. This is always required.
         /// </summary>
@@ -80,6 +87,33 @@ public string IcoPath
             }
         }
 
+        /// <summary>
+        /// The image to be displayed for the badge of the result.
+        /// </summary>
+        /// <value>Can be a local file path or a URL.</value>
+        /// <remarks>If null or empty, will use plugin icon</remarks>
+        public string BadgePath
+        {
+            get => _badgePath;
+            set
+            {
+                // As a standard this property will handle prepping and converting to absolute local path for icon image processing
+                if (!string.IsNullOrEmpty(value)
+                    && !string.IsNullOrEmpty(PluginDirectory)
+                    && !Path.IsPathRooted(value)
+                    && !value.StartsWith("http://", StringComparison.OrdinalIgnoreCase)
+                    && !value.StartsWith("https://", StringComparison.OrdinalIgnoreCase)
+                    && !value.StartsWith("data:image", StringComparison.OrdinalIgnoreCase))
+                {
+                    _badgePath = Path.Combine(PluginDirectory, value);
+                }
+                else
+                {
+                    _badgePath = value;
+                }
+            }
+        }
+
         /// <summary>
         /// Determines if Icon has a border radius
         /// </summary>
@@ -94,7 +128,12 @@ public string IcoPath
         /// <summary>
         /// Delegate to load an icon for this result.
         /// </summary>
-        public IconDelegate Icon;
+        public IconDelegate Icon { get; set; }
+
+        /// <summary>
+        /// Delegate to load an icon for the badge of this result.
+        /// </summary>
+        public IconDelegate BadgeIcon { get; set; }
 
         /// <summary>
         /// Information for Glyph Icon (Prioritized than IcoPath/Icon if user enable Glyph Icons)
@@ -154,47 +193,6 @@ public string PluginDirectory
             }
         }
 
-        /// <inheritdoc />
-        public override string ToString()
-        {
-            return Title + SubTitle + Score;
-        }
-
-        /// <summary>
-        /// Clones the current result
-        /// </summary>
-        public Result Clone()
-        {
-            return new Result
-            {
-                Title = Title,
-                SubTitle = SubTitle,
-                ActionKeywordAssigned = ActionKeywordAssigned,
-                CopyText = CopyText,
-                AutoCompleteText = AutoCompleteText,
-                IcoPath = IcoPath,
-                RoundedIcon = RoundedIcon,
-                Icon = Icon,
-                Glyph = Glyph,
-                Action = Action,
-                AsyncAction = AsyncAction,
-                Score = Score,
-                TitleHighlightData = TitleHighlightData,
-                OriginQuery = OriginQuery,
-                PluginDirectory = PluginDirectory,
-                ContextData = ContextData,
-                PluginID = PluginID,
-                TitleToolTip = TitleToolTip,
-                SubTitleToolTip = SubTitleToolTip,
-                PreviewPanel = PreviewPanel,
-                ProgressBar = ProgressBar,
-                ProgressBarColor = ProgressBarColor,
-                Preview = Preview,
-                AddSelectedCount = AddSelectedCount,
-                RecordKey = RecordKey
-            };
-        }
-
         /// <summary>
         /// Additional data associated with this result
         /// </summary>
@@ -223,16 +221,6 @@ public Result Clone()
         /// </summary>
         public Lazy<UserControl> PreviewPanel { get; set; }
 
-        /// <summary>
-        /// Run this result, asynchronously
-        /// </summary>
-        /// <param name="context"></param>
-        /// <returns></returns>
-        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>
@@ -254,11 +242,6 @@ public ValueTask<bool> ExecuteAsync(ActionContext context)
         /// </summary>
         public bool AddSelectedCount { get; set; } = true;
 
-        /// <summary>
-        /// Maximum score. This can be useful when set one result to the top by default. This is the score for the results set to the topmost by users.
-        /// </summary>
-        public const int MaxScore = int.MaxValue;
-
         /// <summary>
         /// The key to identify the record. This is used when FL checks whether the result is the topmost record. Or FL calculates the hashcode of the result for user selected records.
         /// This can be useful when your plugin will change the Title or SubTitle of the result dynamically.
@@ -267,6 +250,59 @@ public ValueTask<bool> ExecuteAsync(ActionContext context)
         /// </summary>
         public string RecordKey { get; set; } = null;
 
+        /// <summary>
+        /// Run this result, asynchronously
+        /// </summary>
+        /// <param name="context"></param>
+        /// <returns></returns>
+        public ValueTask<bool> ExecuteAsync(ActionContext context)
+        {
+            return AsyncAction?.Invoke(context) ?? ValueTask.FromResult(Action?.Invoke(context) ?? false);
+        }
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return Title + SubTitle + Score;
+        }
+
+        /// <summary>
+        /// Clones the current result
+        /// </summary>
+        public Result Clone()
+        {
+            return new Result
+            {
+                Title = Title,
+                SubTitle = SubTitle,
+                ActionKeywordAssigned = ActionKeywordAssigned,
+                CopyText = CopyText,
+                AutoCompleteText = AutoCompleteText,
+                IcoPath = IcoPath,
+                BadgePath = BadgePath,
+                RoundedIcon = RoundedIcon,
+                Icon = Icon,
+                BadgeIcon = BadgeIcon,
+                Glyph = Glyph,
+                Action = Action,
+                AsyncAction = AsyncAction,
+                Score = Score,
+                TitleHighlightData = TitleHighlightData,
+                OriginQuery = OriginQuery,
+                PluginDirectory = PluginDirectory,
+                ContextData = ContextData,
+                PluginID = PluginID,
+                TitleToolTip = TitleToolTip,
+                SubTitleToolTip = SubTitleToolTip,
+                PreviewPanel = PreviewPanel,
+                ProgressBar = ProgressBar,
+                ProgressBarColor = ProgressBarColor,
+                Preview = Preview,
+                AddSelectedCount = AddSelectedCount,
+                RecordKey = RecordKey
+            };
+        }
+
         /// <summary>
         /// Info of the preview section of a <see cref="Result"/>
         /// </summary>

Flow.Launcher/ViewModel/MainViewModel.cs

@@ -1268,8 +1268,7 @@ async Task QueryTaskAsync(PluginPair plugin, CancellationToken token)
                 // Task.Yield will force it to run in ThreadPool
                 await Task.Yield();
 
-                IReadOnlyList<Result> results =
-                    await PluginManager.QueryForPluginAsync(plugin, query, token);
+                var results = await PluginManager.QueryForPluginAsync(plugin, query, token);
 
                 if (token.IsCancellationRequested)
                     return;
@@ -1285,6 +1284,14 @@ async Task QueryTaskAsync(PluginPair plugin, CancellationToken token)
                     resultsCopy = DeepCloneResults(results, token);
                 }
 
+                foreach (var result in results)
+                {
+                    if (string.IsNullOrEmpty(result.BadgePath))
+                    {
+                        result.BadgePath = plugin.Metadata.IcoPath;
+                    }
+                }
+
                 if (!_resultsUpdateChannelWriter.TryWrite(new ResultsForUpdate(resultsCopy, plugin.Metadata, query,
                     token, reSelect)))
                 {