Support plugin search delay

Author: Jack251970

Flow.Launcher.Infrastructure/UserSettings/PluginSettings.cs

@@ -51,7 +51,7 @@ public void UpdatePluginSettings(List<PluginMetadata> metadatas)
                         settings.Version = metadata.Version;
                     }
                     settings.DefaultActionKeywords = metadata.ActionKeywords; // metadata provides default values
-                    settings.DefaultSearchDelay = metadata.SearchDelay; // metadata provides default values
+                    settings.DefaultSearchDelaySpeed = metadata.SearchDelaySpeed; // metadata provides default values
 
                     // update metadata values with settings
                     if (settings.ActionKeywords?.Count > 0)
@@ -66,7 +66,7 @@ public void UpdatePluginSettings(List<PluginMetadata> metadatas)
                     }
                     metadata.Disabled = settings.Disabled;
                     metadata.Priority = settings.Priority;
-                    metadata.SearchDelay = settings.SearchDelay;
+                    metadata.SearchDelaySpeed = settings.SearchDelaySpeed;
                 }
                 else
                 {
@@ -80,8 +80,8 @@ public void UpdatePluginSettings(List<PluginMetadata> metadatas)
                         ActionKeywords = metadata.ActionKeywords, // use default value
                         Disabled = metadata.Disabled,
                         Priority = metadata.Priority,
-                        DefaultSearchDelay = metadata.SearchDelay, // metadata provides default values
-                        SearchDelay = metadata.SearchDelay, // use default value
+                        DefaultSearchDelaySpeed = metadata.SearchDelaySpeed, // metadata provides default values
+                        SearchDelaySpeed = metadata.SearchDelaySpeed, // use default value
                     };
                 }
             }
@@ -120,9 +120,10 @@ public class Plugin
         public int Priority { get; set; }
 
         [JsonIgnore]
-        public int DefaultSearchDelay { get; set; }
+        public SearchDelaySpeeds? DefaultSearchDelaySpeed { get; set; }
 
-        public int SearchDelay { get; set; }
+        [JsonConverter(typeof(JsonStringEnumConverter))]
+        public SearchDelaySpeeds? SearchDelaySpeed { get; set; }
 
         /// <summary>
         /// Used only to save the state of the plugin in settings

Flow.Launcher.Infrastructure/UserSettings/Settings.cs

@@ -330,8 +330,9 @@ public bool SearchQueryResultsWithDelay
                 OnPropertyChanged();
             }
         }
-
+        
         SearchDelaySpeeds searchDelaySpeed { get; set; } = SearchDelaySpeeds.Medium;
+        [JsonConverter(typeof(JsonStringEnumConverter))]
         public SearchDelaySpeeds SearchDelaySpeed
         {
             get => searchDelaySpeed;
@@ -342,23 +343,6 @@ public SearchDelaySpeeds SearchDelaySpeed
             }
         }
 
-        [JsonIgnore]
-        public int SearchDelay => SearchDelaySpeed switch
-        {
-            SearchDelaySpeeds.Slow => 250,
-            SearchDelaySpeeds.ModeratelySlow => 200,
-            SearchDelaySpeeds.Medium => 150,
-            SearchDelaySpeeds.ModeratelyFast => 100,
-            SearchDelaySpeeds.Fast => 50,
-            _ => 150
-        };
-
-        [JsonIgnore]
-        public List<int> PluginSearchDelayRange { get; } = new()
-        {
-            0, 30, 60, 90, 120, 150
-        };
-
         [JsonConverter(typeof(JsonStringEnumConverter))]
         public SearchWindowScreens SearchWindowScreen { get; set; } = SearchWindowScreens.Cursor;
 
@@ -521,13 +505,4 @@ public enum BackdropTypes
         Mica,
         MicaAlt
     }
-
-    public enum SearchDelaySpeeds
-    {
-        Slow,
-        ModeratelySlow,
-        Medium,
-        ModeratelyFast,
-        Fast
-    }
 }

Flow.Launcher.Plugin/PluginMetadata.cs

@@ -99,9 +99,10 @@ internal set
         public bool HideActionKeywordPanel { get; set; }
 
         /// <summary>
-        /// Plugin search delay in ms.
+        /// Plugin search delay speed. Null means use default search delay.
         /// </summary>
-        public int SearchDelay { get; set; }
+        [JsonConverter(typeof(JsonStringEnumConverter))]
+        public SearchDelaySpeeds? SearchDelaySpeed { get; set; } = null;
 
         /// <summary>
         /// Plugin icon path.

Flow.Launcher.Plugin/SearchDelaySpeeds.cs

@@ -0,0 +1,32 @@
+namespace Flow.Launcher.Plugin;
+
+/// <summary>
+/// Enum for search delay speeds
+/// </summary>
+public enum SearchDelaySpeeds
+{
+    /// <summary>
+    /// Slow search delay speed. 50ms.
+    /// </summary>
+    Slow,
+
+    /// <summary>
+    /// Moderately slow search delay speed. 100ms.
+    /// </summary>
+    ModeratelySlow,
+
+    /// <summary>
+    /// Medium search delay speed. 150ms. Default value.
+    /// </summary>
+    Medium,
+
+    /// <summary>
+    /// Moderately fast search delay speed. 200ms.
+    /// </summary>
+    ModeratelyFast,
+
+    /// <summary>
+    /// Fast search delay speed. 250ms.
+    /// </summary>
+    Fast
+}

Flow.Launcher/Flow.Launcher.csproj

@@ -100,7 +100,6 @@
     <PackageReference Include="NHotkey.Wpf" Version="3.0.0" />
     <PackageReference Include="PropertyChanged.Fody" Version="3.4.0" />
     <PackageReference Include="SemanticVersioning" Version="3.0.0" />
-    <PackageReference Include="System.Reactive.Linq" Version="6.0.1" />
     <PackageReference Include="TaskScheduler" Version="2.12.1" />
     <PackageReference Include="VirtualizingWrapPanel" Version="2.1.1" />
   </ItemGroup>

Flow.Launcher/Languages/en.xaml

@@ -104,8 +104,8 @@
     <system:String x:Key="shadowEffectNotAllowed">Shadow effect is not allowed while current theme has blur effect enabled</system:String>
     <system:String x:Key="searchDelay">Search Delay</system:String>
     <system:String x:Key="searchDelayToolTip">Delay for a while to search when typing. This reduces interface jumpiness and result load.</system:String>
-    <system:String x:Key="searchDelayTime">Search Delay Speed</system:String>
-    <system:String x:Key="searchDelayTimeToolTip">Delay time speed after which search results appear when typing is stopped. Default is medium.</system:String>
+    <system:String x:Key="searchDelaySpeed">Default Search Delay Speed</system:String>
+    <system:String x:Key="searchDelaySpeedToolTip">Plugins default delay time after which search results appear when typing is stopped. Default is medium.</system:String>
     <system:String x:Key="SearchDelaySpeedSlow">Slow</system:String>
     <system:String x:Key="SearchDelaySpeedModeratelySlow">Moderately slow</system:String>
     <system:String x:Key="SearchDelaySpeedMedium">Medium</system:String>
@@ -127,7 +127,8 @@
     <system:String x:Key="currentActionKeywords">Current action keyword</system:String>
     <system:String x:Key="newActionKeyword">New action keyword</system:String>
     <system:String x:Key="actionKeywordsTooltip">Change Action Keywords</system:String>
-    <system:String x:Key="pluginSearchDelayTooltip">Change Seach Delay Time</system:String>
+    <system:String x:Key="pluginSearchDelaySpeed">Plugin seach delay speed</system:String>
+    <system:String x:Key="pluginSearchDelaySpeedTooltip">Change Plugin Seach Delay Speed</system:String>
     <system:String x:Key="currentPriority">Current Priority</system:String>
     <system:String x:Key="newPriority">New Priority</system:String>
     <system:String x:Key="priority">Priority</system:String>
@@ -143,6 +144,7 @@
     <system:String x:Key="failedToRemovePluginSettingsMessage">Plugins: {0} - Fail to remove plugin settings files, please remove them manually</system:String>
     <system:String x:Key="failedToRemovePluginCacheTitle">Fail to remove plugin cache</system:String>
     <system:String x:Key="failedToRemovePluginCacheMessage">Plugins: {0} - Fail to remove plugin cache files, please remove them manually</system:String>
+    <system:String x:Key="default">Default</system:String>
 
     <!--  Setting Plugin Store  -->
     <system:String x:Key="pluginStore">Plugin Store</system:String>

Flow.Launcher/MainWindow.xaml

@@ -252,6 +252,7 @@
                             PreviewKeyUp="QueryTextBox_KeyUp"
                             Style="{DynamicResource QueryBoxStyle}"
                             Text="{Binding QueryText, Mode=OneWay}"
+                            TextChanged="QueryTextBox_TextChanged1"
                             Visibility="Visible"
                             WindowChrome.IsHitTestVisibleInChrome="True">
                             <TextBox.CommandBindings>

Flow.Launcher/MainWindow.xaml.cs

@@ -2,7 +2,6 @@
 using System.ComponentModel;
 using System.Linq;
 using System.Media;
-using System.Reactive.Linq;
 using System.Threading.Tasks;
 using System.Windows;
 using System.Windows.Controls;
@@ -64,9 +63,6 @@ public partial class MainWindow : IDisposable
         private const double DefaultRightMargin = 66; //* this value from base.xaml
         private bool _isClockPanelAnimating = false;
 
-        // Search Delay
-        private IDisposable _reactiveSubscription;
-
         // IDisposable
         private bool _disposed = false;
 
@@ -122,9 +118,6 @@ private async void OnLoaded(object sender, RoutedEventArgs _)
                 welcomeWindow.Show();
             }
 
-            // Initialize search delay
-            SetupSearchTextBoxReactiveness(_settings.SearchQueryResultsWithDelay, _settings.SearchDelay);
-
             // Initialize place holder
             SetupPlaceholderText();
             _viewModel.PlaceholderText = _settings.PlaceholderText;
@@ -267,15 +260,6 @@ private async void OnLoaded(object sender, RoutedEventArgs _)
                     case nameof(Settings.KeepMaxResults):
                         SetupResizeMode();
                         break;
-                    case nameof(Settings.SearchQueryResultsWithDelay):
-                        SetupSearchTextBoxReactiveness(_settings.SearchQueryResultsWithDelay, _settings.SearchDelay);
-                        break;
-                    case nameof(Settings.SearchDelaySpeed):
-                        if (_settings.SearchQueryResultsWithDelay)
-                        {
-                            SetupSearchTextBoxReactiveness(_settings.SearchQueryResultsWithDelay, _settings.SearchDelay);
-                        }
-                        break;
                 }
             };
 
@@ -1126,46 +1110,11 @@ private void SetupResizeMode()
 
         #region Search Delay
 
-        // Edited from: https://github.com/microsoft/PowerToys
-
-        private void SetupSearchTextBoxReactiveness(bool showResultsWithDelay, int searchDelay)
-        {
-            if (_reactiveSubscription != null)
-            {
-                _reactiveSubscription.Dispose();
-                _reactiveSubscription = null;
-            }
-
-            QueryTextBox.TextChanged -= QueryTextBox_TextChanged1;
-
-            if (showResultsWithDelay)
-            {
-                _reactiveSubscription = Observable.FromEventPattern<TextChangedEventHandler, TextChangedEventArgs>(
-                    conversion => (sender, eventArg) => conversion(sender, eventArg),
-                    add => QueryTextBox.TextChanged += add,
-                    remove => QueryTextBox.TextChanged -= remove)
-                    // TODO: Remove debug codes.
-                    .Throttle(TimeSpan.FromMilliseconds(_settings.SearchDelay * 10))
-                    .Do(@event => Dispatcher.Invoke(() => PerformSearchQuery(true, (TextBox)@event.Sender)))
-                    .Subscribe();
-            }
-            else
-            {
-                QueryTextBox.TextChanged += QueryTextBox_TextChanged1;
-            }
-        }
-
         private void QueryTextBox_TextChanged1(object sender, TextChangedEventArgs e)
         {
             var textBox = (TextBox)sender;
-            PerformSearchQuery(false, textBox);
-        }
-
-        private void PerformSearchQuery(bool searchDelay, TextBox textBox)
-        {
-            var text = textBox.Text;
-            _viewModel.QueryText = text;
-            _viewModel.Query(searchDelay);
+            _viewModel.QueryText = textBox.Text;
+            _viewModel.Query(_settings.SearchQueryResultsWithDelay);
         }
 
         #endregion
@@ -1180,7 +1129,6 @@ protected virtual void Dispose(bool disposing)
                 {
                     _hwndSource?.Dispose();
                     _notifyIcon?.Dispose();
-                    _reactiveSubscription?.Dispose();
                 }
 
                 _disposed = true;

Flow.Launcher/Resources/Controls/InstalledPluginSearchDelay.xaml

@@ -32,18 +32,18 @@
                 VerticalAlignment="Center"
                 DockPanel.Dock="Left"
                 Style="{DynamicResource SettingTitleLabel}"
-                Text="{DynamicResource searchDelayTime}" />
+                Text="{DynamicResource pluginSearchDelaySpeed}" />
             <!--  Here Margin="0 -4.5 0 -4.5" is to remove redundant top bottom margin from Margin="{StaticResource SettingPanelMargin}"  -->
-            <ComboBox
+            <Button
                 Width="100"
                 Margin="0 -4.5 0 -4.5"
                 HorizontalAlignment="Right"
+                Command="{Binding SetSearchDelaySpeedCommand}"
+                Content="{Binding SearchDelaySpeedText}"
                 Cursor="Hand"
                 DockPanel.Dock="Right"
                 FontWeight="Bold"
-                ItemsSource="{Binding PluginSearchDelayRange}"
-                SelectedItem="{Binding PluginSearchDelay}"
-                ToolTip="{DynamicResource pluginSearchDelayTooltip}" />
+                ToolTip="{DynamicResource pluginSearchDelaySpeedTooltip}" />
         </DockPanel>
     </Border>
 </UserControl>

Flow.Launcher/SettingPages/Views/SettingsPaneGeneral.xaml

@@ -184,9 +184,9 @@
                 </cc:Card>
 
                 <cc:Card
-                    Title="{DynamicResource searchDelayTime}"
+                    Title="{DynamicResource searchDelaySpeed}"
                     Icon="&#xE916;"
-                    Sub="{DynamicResource searchDelayTimeToolTip}">
+                    Sub="{DynamicResource searchDelaySpeedToolTip}">
                     <ComboBox
                         MaxWidth="200"
                         DisplayMemberPath="Display"