Merge pull request #3350 from Jack251970/search_delay

Input Smooth & Search delay

Author: Jack251970

Flow.Launcher.Core/Plugin/PluginManager.cs

@@ -622,7 +622,7 @@ internal static async Task UninstallPluginAsync(PluginMetadata plugin, bool remo
                     API.ShowMsg(API.GetTranslation("failedToRemovePluginCacheTitle"),
                         string.Format(API.GetTranslation("failedToRemovePluginCacheMessage"), plugin.Name));
                 }
-                Settings.Plugins.Remove(plugin.ID);
+                Settings.RemovePluginSettings(plugin.ID);
                 AllPlugins.RemoveAll(p => p.Metadata.ID == plugin.ID);
             }
 

Flow.Launcher.Core/Plugin/PluginsLoader.cs

@@ -50,7 +50,7 @@ public static List<PluginPair> Plugins(List<PluginMetadata> metadatas, PluginsSe
             return plugins;
         }
 
-        public static IEnumerable<PluginPair> DotNetPlugins(List<PluginMetadata> source)
+        private static IEnumerable<PluginPair> DotNetPlugins(List<PluginMetadata> source)
         {
             var erroredPlugins = new List<string>();
 
@@ -132,7 +132,7 @@ public static IEnumerable<PluginPair> DotNetPlugins(List<PluginMetadata> source)
             return plugins;
         }
 
-        public static IEnumerable<PluginPair> ExecutablePlugins(IEnumerable<PluginMetadata> source)
+        private static IEnumerable<PluginPair> ExecutablePlugins(IEnumerable<PluginMetadata> source)
         {
             return source
                 .Where(o => o.Language.Equals(AllowedLanguage.Executable, StringComparison.OrdinalIgnoreCase))
@@ -146,7 +146,7 @@ public static IEnumerable<PluginPair> ExecutablePlugins(IEnumerable<PluginMetada
                 });
         }
 
-        public static IEnumerable<PluginPair> ExecutableV2Plugins(IEnumerable<PluginMetadata> source)
+        private static IEnumerable<PluginPair> ExecutableV2Plugins(IEnumerable<PluginMetadata> source)
         {
             return source
                 .Where(o => o.Language.Equals(AllowedLanguage.ExecutableV2, StringComparison.OrdinalIgnoreCase))

Flow.Launcher.Infrastructure/UserSettings/PluginSettings.cs

@@ -1,13 +1,15 @@
 using System.Collections.Generic;
+using System.Text.Json.Serialization;
 using Flow.Launcher.Plugin;
 
 namespace Flow.Launcher.Infrastructure.UserSettings
 {
     public class PluginsSettings : BaseModel
     {
         private string pythonExecutablePath = string.Empty;
-        public string PythonExecutablePath {
-            get { return pythonExecutablePath; }
+        public string PythonExecutablePath
+        {
+            get => pythonExecutablePath;
             set
             {
                 pythonExecutablePath = value;
@@ -18,25 +20,40 @@ public string PythonExecutablePath {
         private string nodeExecutablePath = string.Empty;
         public string NodeExecutablePath
         {
-            get { return nodeExecutablePath; }
+            get => nodeExecutablePath;
             set 
             {
                 nodeExecutablePath = value;
                 Constant.NodePath = value;
             }
         }
 
-        public Dictionary<string, Plugin> Plugins { get; set; } = new Dictionary<string, Plugin>();
+        /// <summary>
+        /// Only used for serialization
+        /// </summary>
+        public Dictionary<string, Plugin> Plugins { get; set; } = new();
 
+        /// <summary>
+        /// Update plugin settings with metadata.
+        /// FL will get default values from metadata first and then load settings to metadata
+        /// </summary>
+        /// <param name="metadatas">Parsed plugin metadatas</param>
         public void UpdatePluginSettings(List<PluginMetadata> metadatas)
         {
             foreach (var metadata in metadatas)
             {
                 if (Plugins.TryGetValue(metadata.ID, out var settings))
                 {
+                    // If settings exist, update settings & metadata value
+                    // update settings values with metadata
                     if (string.IsNullOrEmpty(settings.Version))
+                    {
                         settings.Version = metadata.Version;
+                    }
+                    settings.DefaultActionKeywords = metadata.ActionKeywords; // metadata provides default values
+                    settings.DefaultSearchDelayTime = metadata.SearchDelayTime; // metadata provides default values
 
+                    // update metadata values with settings
                     if (settings.ActionKeywords?.Count > 0)
                     {
                         metadata.ActionKeywords = settings.ActionKeywords;
@@ -49,30 +66,65 @@ public void UpdatePluginSettings(List<PluginMetadata> metadatas)
                     }
                     metadata.Disabled = settings.Disabled;
                     metadata.Priority = settings.Priority;
+                    metadata.SearchDelayTime = settings.SearchDelayTime;
                 }
                 else
                 {
+                    // If settings does not exist, create a new one
                     Plugins[metadata.ID] = new Plugin
                     {
                         ID = metadata.ID,
                         Name = metadata.Name,
                         Version = metadata.Version,
-                        ActionKeywords = metadata.ActionKeywords, 
+                        DefaultActionKeywords = metadata.ActionKeywords, // metadata provides default values
+                        ActionKeywords = metadata.ActionKeywords, // use default value
                         Disabled = metadata.Disabled,
-                        Priority = metadata.Priority
+                        Priority = metadata.Priority,
+                        DefaultSearchDelayTime = metadata.SearchDelayTime, // metadata provides default values
+                        SearchDelayTime = metadata.SearchDelayTime, // use default value
                     };
                 }
             }
         }
+
+        public Plugin GetPluginSettings(string id)
+        {
+            if (Plugins.TryGetValue(id, out var plugin))
+            {
+                return plugin;
+            }
+            return null;
+        }
+
+        public Plugin RemovePluginSettings(string id)
+        {
+            Plugins.Remove(id, out var plugin);
+            return plugin;
+        }
     }
+
     public class Plugin
     {
         public string ID { get; set; }
+
         public string Name { get; set; }
+
         public string Version { get; set; }
-        public List<string> ActionKeywords { get; set; } // a reference of the action keywords from plugin manager
+
+        [JsonIgnore]
+        public List<string> DefaultActionKeywords { get; set; }
+
+        // a reference of the action keywords from plugin manager
+        public List<string> ActionKeywords { get; set; }
+
         public int Priority { get; set; }
 
+        [JsonIgnore]
+        public SearchDelayTime? DefaultSearchDelayTime { get; set; }
+
+        [JsonConverter(typeof(JsonStringEnumConverter))]
+        public SearchDelayTime? SearchDelayTime { get; set; }
+
         /// <summary>
         /// Used only to save the state of the plugin in settings
         /// </summary>

Flow.Launcher.Infrastructure/UserSettings/Settings.cs

@@ -112,7 +112,7 @@ public string Theme
         public double SettingWindowHeight { get; set; } = 700;
         public double? SettingWindowTop { get; set; } = null;
         public double? SettingWindowLeft { get; set; } = null;
-        public System.Windows.WindowState SettingWindowState { get; set; } = WindowState.Normal;
+        public WindowState SettingWindowState { get; set; } = WindowState.Normal;
 
         bool _showPlaceholder { get; set; } = false;
         public bool ShowPlaceholder
@@ -310,7 +310,7 @@ public bool KeepMaxResults
         bool _hideNotifyIcon { get; set; }
         public bool HideNotifyIcon
         {
-            get { return _hideNotifyIcon; }
+            get => _hideNotifyIcon;
             set
             {
                 _hideNotifyIcon = value;
@@ -320,6 +320,11 @@ public bool HideNotifyIcon
         public bool LeaveCmdOpen { get; set; }
         public bool HideWhenDeactivated { get; set; } = true;
 
+        public bool SearchQueryResultsWithDelay { get; set; }
+
+        [JsonConverter(typeof(JsonStringEnumConverter))]
+        public SearchDelayTime SearchDelayTime { get; set; } = SearchDelayTime.Normal;
+
         [JsonConverter(typeof(JsonStringEnumConverter))]
         public SearchWindowScreens SearchWindowScreen { get; set; } = SearchWindowScreens.Cursor;
 
@@ -342,7 +347,6 @@ public bool HideNotifyIcon
         [JsonIgnore]
         public bool WMPInstalled { get; set; } = true;
 
-
         // This needs to be loaded last by staying at the bottom
         public PluginsSettings PluginSettings { get; set; } = new PluginsSettings();
 

Flow.Launcher.Plugin/PluginMetadata.cs

@@ -92,12 +92,18 @@ internal set
         /// All action keywords of plugin.
         /// </summary>
         public List<string> ActionKeywords { get; set; }
-        
+
         /// <summary>
         /// Hide plugin keyword setting panel.
         /// </summary>
         public bool HideActionKeywordPanel { get; set; }
 
+        /// <summary>
+        /// Plugin search delay time. Null means use default search delay time.
+        /// </summary>
+        [JsonConverter(typeof(JsonStringEnumConverter))]
+        public SearchDelayTime? SearchDelayTime { get; set; } = null;
+
         /// <summary>
         /// Plugin icon path.
         /// </summary>

Flow.Launcher.Plugin/SearchDelayTime.cs

@@ -0,0 +1,32 @@
+namespace Flow.Launcher.Plugin;
+
+/// <summary>
+/// Enum for search delay time
+/// </summary>
+public enum SearchDelayTime
+{
+    /// <summary>
+    /// Very long search delay time. 250ms.
+    /// </summary>
+    VeryLong,
+
+    /// <summary>
+    /// Long search delay time. 200ms.
+    /// </summary>
+    Long,
+
+    /// <summary>
+    /// Normal search delay time. 150ms. Default value.
+    /// </summary>
+    Normal,
+
+    /// <summary>
+    /// Short search delay time. 100ms.
+    /// </summary>
+    Short,
+
+    /// <summary>
+    /// Very short search delay time. 50ms.
+    /// </summary>
+    VeryShort
+}

Flow.Launcher/Languages/en.xaml

@@ -102,6 +102,15 @@
     <system:String x:Key="AlwaysPreview">Always Preview</system:String>
     <system:String x:Key="AlwaysPreviewToolTip">Always open preview panel when Flow activates. Press {0} to toggle preview.</system:String>
     <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">Default Search Delay Time</system:String>
+    <system:String x:Key="searchDelayTimeToolTip">Plugin default delay time after which search results appear when typing is stopped.</system:String>
+    <system:String x:Key="SearchDelayTimeVeryLong">Very long</system:String>
+    <system:String x:Key="SearchDelayTimeLong">Long</system:String>
+    <system:String x:Key="SearchDelayTimeNormal">Normal</system:String>
+    <system:String x:Key="SearchDelayTimeShort">Short</system:String>
+    <system:String x:Key="SearchDelayTimeVeryShort">Very short</system:String>
 
     <!--  Setting Plugin  -->
     <system:String x:Key="searchplugin">Search Plugin</system:String>
@@ -118,6 +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="pluginSearchDelayTime">Plugin seach delay time</system:String>
+    <system:String x:Key="pluginSearchDelayTimeTooltip">Change Plugin Seach Delay Time</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>
@@ -133,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>
@@ -353,6 +365,12 @@
     <system:String x:Key="completedSuccessfully">Completed successfully</system:String>
     <system:String x:Key="actionkeyword_tips">Enter the action keywords you like to use to start the plugin and use whitespace to divide them. Use * if you don't want to specify any, and the plugin will be triggered without any action keywords.</system:String>
 
+    <!--  Search Delay Settings Dialog  -->
+    <system:String x:Key="searchDelayTimeTitle">Search Delay Time Setting</system:String>
+    <system:String x:Key="searchDelayTime_tips">Select the search delay time you like to use for the plugin. Select "{0}" if you don't want to specify any, and the plugin will use default search delay time.</system:String>
+    <system:String x:Key="currentSearchDelayTime">Current search delay time</system:String>
+    <system:String x:Key="newSearchDelayTime">New search delay time</system:String>
+
     <!--  Custom Query Hotkey Dialog  -->
     <system:String x:Key="customeQueryHotkeyTitle">Custom Query Hotkey</system:String>
     <system:String x:Key="customeQueryHotkeyTips">Press a custom hotkey to open Flow Launcher and input the specified query automatically.</system:String>

Flow.Launcher/MainWindow.xaml

@@ -251,7 +251,8 @@
                             PreviewDragOver="QueryTextBox_OnPreviewDragOver"
                             PreviewKeyUp="QueryTextBox_KeyUp"
                             Style="{DynamicResource QueryBoxStyle}"
-                            Text="{Binding QueryText, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged}"
+                            Text="{Binding QueryText, Mode=OneWay}"
+                            TextChanged="QueryTextBox_TextChanged1"
                             Visibility="Visible"
                             WindowChrome.IsHitTestVisibleInChrome="True">
                             <TextBox.CommandBindings>

Flow.Launcher/MainWindow.xaml.cs

@@ -22,6 +22,8 @@
 using Flow.Launcher.Plugin.SharedCommands;
 using Flow.Launcher.ViewModel;
 using ModernWpf.Controls;
+using DataObject = System.Windows.DataObject;
+using Key = System.Windows.Input.Key;
 using MouseButtons = System.Windows.Forms.MouseButtons;
 using NotifyIcon = System.Windows.Forms.NotifyIcon;
 using Screen = System.Windows.Forms.Screen;
@@ -165,6 +167,8 @@ private async void OnLoaded(object sender, RoutedEventArgs _)
             // Set the initial state of the QueryTextBoxCursorMovedToEnd property
             // Without this part, when shown for the first time, switching the context menu does not move the cursor to the end.
             _viewModel.QueryTextCursorMovedToEnd = false;
+            
+            // View model property changed event
             _viewModel.PropertyChanged += (o, e) =>
             {
                 switch (e.PropertyName)
@@ -227,6 +231,7 @@ private async void OnLoaded(object sender, RoutedEventArgs _)
                 }
             };
 
+            // Settings property changed event
             _settings.PropertyChanged += (o, e) =>
             {
                 switch (e.PropertyName)
@@ -1050,7 +1055,7 @@ private void QueryTextBox_OnPreviewDragOver(object sender, DragEventArgs e)
         {
             e.Handled = true;
         }
-
+        
         #endregion
 
         #region Placeholder
@@ -1101,6 +1106,17 @@ private void SetupResizeMode()
             }
         }
 
+        #endregion
+        
+        #region Search Delay
+
+        private void QueryTextBox_TextChanged1(object sender, TextChangedEventArgs e)
+        {
+            var textBox = (TextBox)sender;
+            _viewModel.QueryText = textBox.Text;
+            _viewModel.Query(_settings.SearchQueryResultsWithDelay);
+        }
+
         #endregion
 
         #region IDisposable