Merge pull request #3438 from onesounds/250410-PluginBadge2

Result Badge

Author: onesounds

Flow.Launcher.Infrastructure/UserSettings/Settings.cs

@@ -101,6 +101,8 @@ public string Theme
         public bool UseAnimation { get; set; } = true;
         public bool UseSound { get; set; } = true;
         public double SoundVolume { get; set; } = 50;
+        public bool ShowBadges { get; set; } = false;
+        public bool ShowBadgesGlobalOnly { get; set; } = false;
 
         public bool UseClock { get; set; } = true;
         public bool UseDate { get; set; } = false;

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 _badgeIcoPath;
+
         /// <summary>
         /// The title of the result. This is always required.
         /// </summary>
@@ -60,7 +67,7 @@ public string CopyText
         /// <remarks>GlyphInfo is prioritized if not null</remarks>
         public string IcoPath
         {
-            get { return _icoPath; }
+            get => _icoPath;
             set
             {
                 // As a standard this property will handle prepping and converting to absolute local path for icon image processing
@@ -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 BadgeIcoPath
+        {
+            get => _badgeIcoPath;
+            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))
+                {
+                    _badgeIcoPath = Path.Combine(PluginDirectory, value);
+                }
+                else
+                {
+                    _badgeIcoPath = value;
+                }
+            }
+        }
+
         /// <summary>
         /// Determines if Icon has a border radius
         /// </summary>
@@ -94,14 +128,18 @@ 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)
         /// </summary>
         public GlyphInfo Glyph { get; init; }
 
-
         /// <summary>
         /// An action to take in the form of a function call when the result has been selected.
         /// </summary>
@@ -143,59 +181,19 @@ public string IcoPath
         /// </summary>
         public string PluginDirectory
         {
-            get { return _pluginDirectory; }
+            get => _pluginDirectory;
             set
             {
                 _pluginDirectory = value;
 
                 // When the Result object is returned from the query call, PluginDirectory is not provided until
                 // UpdatePluginMetadata call is made at PluginManager.cs L196. Once the PluginDirectory becomes available
-                // we need to update (only if not Uri path) the IcoPath with the full absolute path so the image can be loaded.
+                // we need to update (only if not Uri path) the IcoPath and BadgeIcoPath with the full absolute path so the image can be loaded.
                 IcoPath = _icoPath;
+                BadgeIcoPath = _badgeIcoPath;
             }
         }
 
-        /// <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>
@@ -224,16 +222,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>
@@ -255,11 +243,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.
@@ -268,6 +251,66 @@ public ValueTask<bool> ExecuteAsync(ActionContext context)
         /// </summary>
         public string RecordKey { get; set; } = null;
 
+        /// <summary>
+        /// Determines if the badge icon should be shown.
+        /// If users want to show the result badges and here you set this to true, the results will show the badge icon.
+        /// </summary>
+        public bool ShowBadge { get; set; } = false;
+
+        /// <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,
+                BadgeIcoPath = BadgeIcoPath,
+                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,
+                ShowBadge = ShowBadge,
+            };
+        }
+
         /// <summary>
         /// Info of the preview section of a <see cref="Result"/>
         /// </summary>

Flow.Launcher/Converters/BadgePositionConverter.cs

@@ -0,0 +1,32 @@
+using System;
+using System.Globalization;
+using System.Windows.Data;
+
+namespace Flow.Launcher.Converters;
+
+public class BadgePositionConverter : IValueConverter
+{
+    public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
+    {
+        if (value is double actualWidth && parameter is string param)
+        {
+            double offset = actualWidth / 2 - 8;
+
+            if (param == "1") // X-Offset
+            {
+                return offset + 2;
+            }
+            else if (param == "2") // Y-Offset
+            {
+                return offset + 2;
+            }
+        }
+
+        return 0.0;
+    }
+
+    public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
+    {
+        throw new NotSupportedException();
+    }
+}

Flow.Launcher/Converters/SizeRatioConverter.cs

@@ -0,0 +1,27 @@
+using System.Windows.Data;
+using System;
+using System.Globalization;
+using System.Windows;
+
+namespace Flow.Launcher.Converters;
+
+public class SizeRatioConverter : IValueConverter
+{
+    public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
+    {
+        if (value is double size && parameter is string ratioString)
+        {
+            if (double.TryParse(ratioString, NumberStyles.Any, CultureInfo.InvariantCulture, out double ratio))
+            {
+                return size * ratio;
+            }
+        }
+
+        return 0.0;
+    }
+
+    public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
+    {
+        throw new NotSupportedException();
+    }
+}

Flow.Launcher/Languages/en.xaml

@@ -298,6 +298,10 @@
     <system:String x:Key="useGlyphUI">Use Segoe Fluent Icons</system:String>
     <system:String x:Key="useGlyphUIEffect">Use Segoe Fluent Icons for query results where supported</system:String>
     <system:String x:Key="flowlauncherPressHotkey">Press Key</system:String>
+    <system:String x:Key="showBadges">Show Result Badges</system:String>
+    <system:String x:Key="showBadgesToolTip">Show badges for query results where supported</system:String>
+    <system:String x:Key="showBadgesGlobalOnly">Show Result Badges for Global Query Only</system:String>
+    <system:String x:Key="showBadgesGlobalOnlyToolTip">Show badges for global query results only</system:String>
 
     <!--  Setting Proxy  -->
     <system:String x:Key="proxy">HTTP Proxy</system:String>