Skip to content

A Swiss Army knife for developers.

Implemented search bar

Etienne Baudoux60a32e11088e
diff --git a/src/Directory.Packages.props b/src/Directory.Packages.props
index 8ad36ede9..419162c24 100644
--- a/src/Directory.Packages.props
+++ b/src/Directory.Packages.props
@@ -24,6 +24,7 @@
<PackageVersion Include="CommunityToolkit.WinUI.UI" Version="$(CommunityToolkitWinUINuGetVersion)" />
<PackageVersion Include="CommunityToolkit.WinUI.UI.Animations" Version="$(CommunityToolkitWinUINuGetVersion)" />
<PackageVersion Include="coverlet.collector" Version="3.1.2" />
+ <PackageVersion Include="FuzzySharp" Version="2.0.2" />
<PackageVersion Include="Microsoft.CodeAnalysis.CSharp" Version="4.4.0" />
<PackageVersion Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.4" />
<PackageVersion Include="Microsoft.CSharp" Version="4.7.0" />
diff --git a/src/app/dev/DevToys.Api/Core/ObservableCollectionExtensions.cs b/src/app/dev/DevToys.Api/Core/ObservableCollectionExtensions.cs
new file mode 100644
index 000000000..e704b8358
--- /dev/null
+++ b/src/app/dev/DevToys.Api/Core/ObservableCollectionExtensions.cs
@@ -0,0 +1,69 @@
+using System.Collections.ObjectModel;
+
+namespace DevToys.Api.Core;
+
+public static class ObservableCollectionExtensions
+{
+ /// <summary>
+ /// Adds the elements of the specified collection to the end of the ObservableCollection(Of T).
+ /// </summary>
+ public static void AddRange<T>(this ObservableCollection<T> origin, IEnumerable<T> newItems)
+ {
+ Guard.IsNotNull(origin);
+ if (newItems is null)
+ {
+ return;
+ }
+
+ foreach (T item in newItems)
+ {
+ origin.Add(item);
+ }
+ }
+
+ // TODO: Write unit tests
+ /// <summary>
+ /// Update the difference between the current items in the collection and the <paramref name="newItems"/>.
+ /// </summary>
+ public static void Update<T>(this ObservableCollection<T> origin, IEnumerable<T> newItems)
+ {
+ Guard.IsNotNull(origin);
+ if (newItems is null)
+ {
+ return;
+ }
+
+ // First, remove the items that aren't part of the new list items.
+ var oldToolsMenuItems = origin.ToList();
+ for (int i = 0; i < oldToolsMenuItems.Count; i++)
+ {
+ T item = oldToolsMenuItems[i];
+ if (!newItems.Contains(item))
+ {
+ origin.Remove(item);
+ }
+ }
+
+ // Then:
+ // 1. If an item from newItems already exist in the collection, but at a different position, move it to the desired index.
+ // 2. If an item from newItems doesn't exist in the collection, insert it with respect of the position of older items in the collection.
+ int insertionIndex = 0;
+ foreach (T? item in newItems)
+ {
+ int indexOfItemInOldMenu = origin.IndexOf(item);
+ if (indexOfItemInOldMenu > -1 && insertionIndex < origin.Count)
+ {
+ if (indexOfItemInOldMenu != insertionIndex)
+ {
+ origin.Move(indexOfItemInOldMenu, insertionIndex);
+ }
+ }
+ else
+ {
+ origin.Insert(insertionIndex, item);
+ }
+
+ insertionIndex++;
+ }
+ }
+}
diff --git a/src/app/dev/DevToys.Core/DevToys.Core.csproj b/src/app/dev/DevToys.Core/DevToys.Core.csproj
index d232b3577..544968672 100644
--- a/src/app/dev/DevToys.Core/DevToys.Core.csproj
+++ b/src/app/dev/DevToys.Core/DevToys.Core.csproj
@@ -10,6 +10,7 @@
<PackageReference Include="CommunityToolkit.Common" />
<PackageReference Include="CommunityToolkit.Diagnostics" />
<PackageReference Include="CommunityToolkit.Mvvm" />
+ <PackageReference Include="FuzzySharp" />
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" />
<PackageReference Include="Newtonsoft.Json" />
<PackageReference Include="System.ComponentModel.Composition" />
diff --git a/src/app/dev/DevToys.Core/Tools/GuiToolInstance.cs b/src/app/dev/DevToys.Core/Tools/GuiToolInstance.cs
index 57e5ae792..0621f39f1 100644
--- a/src/app/dev/DevToys.Core/Tools/GuiToolInstance.cs
+++ b/src/app/dev/DevToys.Core/Tools/GuiToolInstance.cs
@@ -14,6 +14,11 @@ public sealed partial class GuiToolInstance
private readonly Lazy<IGuiTool, GuiToolMetadata> _guiToolDefinition;
private readonly Lazy<IGuiTool> _instance;
private readonly Lazy<ResourceManager?> _resourceManager;
+ private readonly Lazy<string> _shortDisplayTitle;
+ private readonly Lazy<string> _longDisplayTitle;
+ private readonly Lazy<string> _descriptionDisplayTitle;
+ private readonly Lazy<string> _accessibleNameDisplayTitle;
+ private readonly Lazy<string> _searchKeywordsDisplayTitle;
internal GuiToolInstance(Lazy<IGuiTool, GuiToolMetadata> guiToolDefinition, Assembly? resourceManagerAssembly)
{
@@ -21,12 +26,19 @@ public sealed partial class GuiToolInstance
_guiToolDefinition = guiToolDefinition;
_resourceManager = new(() => GetResourceManager(resourceManagerAssembly));
+ _shortDisplayTitle = new(() => GetDisplayString(_guiToolDefinition.Metadata.ShortDisplayTitleResourceName));
+ _longDisplayTitle = new(() => GetDisplayString(_guiToolDefinition.Metadata.LongDisplayTitleResourceName));
+ _descriptionDisplayTitle = new(() => GetDisplayString(_guiToolDefinition.Metadata.DescriptionResourceName));
+ _accessibleNameDisplayTitle = new(() => GetDisplayString(_guiToolDefinition.Metadata.AccessibleNameResourceName));
+ _searchKeywordsDisplayTitle = new(() => GetDisplayString(_guiToolDefinition.Metadata.SearchKeywordsResourceName));
+
_instance = new(() =>
{
IGuiTool instance = _guiToolDefinition.Value;
LogInstanceCreated(_guiToolDefinition.Metadata.InternalComponentName);
return instance;
});
+
LogInitialized(_guiToolDefinition.Metadata.InternalComponentName);
}
@@ -38,15 +50,15 @@ public sealed partial class GuiToolInstance
public string IconGlyph => _guiToolDefinition.Metadata.IconGlyph;
- public string ShortDisplayTitle => GetDisplayString(_guiToolDefinition.Metadata.ShortDisplayTitleResourceName);
+ public string ShortDisplayTitle => _shortDisplayTitle.Value;
- public string LongDisplayTitle => GetDisplayString(_guiToolDefinition.Metadata.LongDisplayTitleResourceName);
+ public string LongDisplayTitle => _longDisplayTitle.Value;
- public string Description => GetDisplayString(_guiToolDefinition.Metadata.DescriptionResourceName);
+ public string Description => _descriptionDisplayTitle.Value;
- public string AccessibleName => GetDisplayString(_guiToolDefinition.Metadata.AccessibleNameResourceName);
+ public string AccessibleName => _accessibleNameDisplayTitle.Value;
- public string SearchKeywords => GetDisplayString(_guiToolDefinition.Metadata.SearchKeywordsResourceName);
+ public string SearchKeywords => _searchKeywordsDisplayTitle.Value;
public bool NotSearchable => _guiToolDefinition.Metadata.NotSearchable;
diff --git a/src/app/dev/DevToys.Core/Tools/GuiToolProvider.cs b/src/app/dev/DevToys.Core/Tools/GuiToolProvider.cs
index e77fff51f..43887656c 100644
--- a/src/app/dev/DevToys.Core/Tools/GuiToolProvider.cs
+++ b/src/app/dev/DevToys.Core/Tools/GuiToolProvider.cs
@@ -1,10 +1,15 @@
using System.Collections.ObjectModel;
using System.Reflection;
using DevToys.Api;
+using DevToys.Api.Core;
using DevToys.Core.Settings;
using DevToys.Core.Tools.Metadata;
using DevToys.Core.Tools.ViewItems;
+using DevToys.Localization;
using DevToys.Localization.Strings.MainMenu;
+using DevToys.Localization.Strings.MainWindow;
+using FuzzySharp;
+using FuzzySharp.PreProcess;
using Microsoft.Extensions.Logging;
using Uno.Extensions;
@@ -16,6 +21,23 @@ namespace DevToys.Core.Tools;
[Export(typeof(GuiToolProvider))]
public sealed partial class GuiToolProvider
{
+ public static readonly GuiToolViewItem NoResultFoundItem
+ = new(
+ new GuiToolInstance(
+ new Lazy<IGuiTool, GuiToolMetadata>(
+ GuiToolMetadata.Create(
+ internalComponentName: "NoSearchResults",
+ author: "N/A",
+ iconFontName: "FluentSystemIcons",
+ iconGlyph: "\uF3E9",
+ groupName: "N/A",
+ shortDisplayTitleResourceName: "N/A",
+ longDisplayTitleResourceName: nameof(MainWindow.SearchNoResultsFound),
+ resourceManagerAssemblyIdentifier: nameof(DevToysLocalizationResourceManagerAssemblyIdentifier),
+ resourceManagerBaseName: "DevToys.Localization.Strings.MainWindow.MainWindow")),
+ typeof(DevToysLocalizationResourceManagerAssemblyIdentifier).Assembly),
+ showLongDisplayTitle: true);
+
private readonly ILogger _logger;
private readonly IEnumerable<Lazy<IResourceManagerAssemblyIdentifier, ResourceManagerAssemblyIdentifierMetadata>> _resourceManagerAssemblyIdentifiers;
private readonly IEnumerable<Lazy<GuiToolGroup, GuiToolGroupMetadata>> _guiToolGroups;
@@ -245,6 +267,62 @@ public sealed partial class GuiToolProvider
}
}
+ /// <summary>
+ /// Search the given <paramref name="searchQuery"/> in the list of known tools and update the given <paramref name="searchResultListToUpdate"/>
+ /// to reflect the result.
+ /// </summary>
+ public void SearchTools(string searchQuery, ObservableCollection<GuiToolViewItem> searchResultListToUpdate)
+ {
+ if (string.IsNullOrEmpty(searchQuery))
+ {
+ searchResultListToUpdate.Clear();
+ return;
+ }
+
+ string[] searchQueries = searchQuery.Split(new char[] { ' ', '\t' }, StringSplitOptions.RemoveEmptyEntries);
+
+ var weightedToolList = new List<(double weight, GuiToolViewItem tool)>();
+ for (int i = 0; i < AllTools.Count; i++)
+ {
+ GuiToolInstance tool = AllTools[i];
+
+ if (!tool.NotSearchable // do not search tools marked as non-searchable
+ && !string.IsNullOrWhiteSpace(tool.LongDisplayTitle)) // do not search tools without long display name.
+ {
+ SearchTool(searchQueries, tool, out MatchSpan[] matchedSpans, out double weight);
+
+ weightedToolList.Add(
+ new(
+ weight,
+ new GuiToolViewItem(
+ tool,
+ showLongDisplayTitle: true,
+ matchedSpans)));
+ }
+ }
+
+ searchResultListToUpdate.Clear();
+
+ if (weightedToolList.Count > 0)
+ {
+ var descOrderedWeightedToolList = weightedToolList.OrderByDescending(i => i.weight).ToList();
+ int thirdQuarterItemIndex = Math.Min((int)(0.25 * descOrderedWeightedToolList.Count), descOrderedWeightedToolList.Count - 1);
+ double thirdQuarterWeight = descOrderedWeightedToolList[thirdQuarterItemIndex].weight;
+
+ searchResultListToUpdate
+ .AddRange(
+ descOrderedWeightedToolList
+ .Take(5)
+ .TakeWhile(i => i.weight >= thirdQuarterWeight)
+ .Select(i => i.tool));
+ }
+
+ if (searchResultListToUpdate.Count == 0)
+ {
+ searchResultListToUpdate.Add(NoResultFoundItem);
+ }
+ }
+
private void BuildGuiToolInstances(
IEnumerable<Lazy<IGuiTool, GuiToolMetadata>> guiTools,
out IReadOnlyList<GuiToolInstance> allTools,
@@ -477,6 +555,71 @@ public sealed partial class GuiToolProvider
return new SettingDefinition<bool>($"{guiToolInstance.InternalComponentName}_IsFavorite", defaultValue: false);
}
+ private static void SearchTool(string[] searchQueries, GuiToolInstance tool, out MatchSpan[] matchedSpans, out double weight)
+ {
+ var matches = new List<MatchSpan>();
+ weight = 0;
+ foreach (string? query in searchQueries)
+ {
+ WeightMatch(query, tool.LongDisplayTitle, out double weight1, out IReadOnlyList<MatchSpan> spans);
+ WeightMatch(query, tool.SearchKeywords, out double weight2, out _);
+ WeightMatch(query, tool.Description, out double weight3, out _);
+ weight = weight + weight1 + weight2 + weight3;
+ matches.AddRange(spans);
+ }
+
+ matchedSpans = matches.Distinct().ToArray();
+ }
+
+ private static void WeightMatch(
+ string searchQuery,
+ string stringToTestAgainst,
+ out double weight,
+ out IReadOnlyList<MatchSpan> matchSpans)
+ {
+ var matches = new List<MatchSpan>();
+ matchSpans = matches;
+ weight = 0;
+
+ if (string.IsNullOrWhiteSpace(stringToTestAgainst))
+ {
+ return;
+ }
+
+ // Fuzzy search.
+ int i;
+ string[] stringToTestAgainstSplitted = stringToTestAgainst.Split(new char[] { ' ', '\t' }, StringSplitOptions.RemoveEmptyEntries);
+ for (i = 0; i < stringToTestAgainstSplitted.Length; i++)
+ {
+ weight += Fuzz.WeightedRatio(searchQuery, stringToTestAgainstSplitted[i], PreprocessMode.Full);
+ }
+
+ if (weight > 0)
+ {
+ // Search substrings.
+ i = 0;
+ while (i < stringToTestAgainst?.Length && i > -1)
+ {
+ int matchIndex = stringToTestAgainst.IndexOf(searchQuery, i, StringComparison.OrdinalIgnoreCase);
+ if (matchIndex > -1)
+ {
+ if (matchIndex == 0)
+ {
+ // if it's a prefix, add an extra 25%.
+ weight *= 1.25;
+ }
+
+ matches.Add(new MatchSpan(matchIndex, searchQuery.Length));
+ i = matchIndex + searchQuery.Length;
+ weight *= 1.25; // add 25%.
+
+ }
+
+ i++;
+ }
+ }
+ }
+
[LoggerMessage(0, LogLevel.Information, "Set '{toolName}' as the most recently used tool.")]
partial void LogSetMostRecentUsedTool(string toolName);
}
diff --git a/src/app/dev/DevToys.Core/Tools/Metadata/GuiToolMetadata.cs b/src/app/dev/DevToys.Core/Tools/Metadata/GuiToolMetadata.cs
index f4e86268f..20fd56df2 100644
--- a/src/app/dev/DevToys.Core/Tools/Metadata/GuiToolMetadata.cs
+++ b/src/app/dev/DevToys.Core/Tools/Metadata/GuiToolMetadata.cs
@@ -1,52 +1,38 @@
using DevToys.Api;
using DevToys.Api.Tool.Metadata.Attributes;
+using DevToys.Localization;
+using DevToys.Localization.Strings.MainWindow;
namespace DevToys.Core.Tools.Metadata;
[DebuggerDisplay($"InternalComponentName = {{{nameof(InternalComponentName)}}}")]
public sealed class GuiToolMetadata : IOrderableMetadata
{
- public string InternalComponentName { get; }
-
- public string Author { get; }
-
- public string IconFontName { get; }
-
- public string IconGlyph { get; }
-
- public string ResourceManagerAssemblyIdentifier { get; }
-
- public string ResourceManagerBaseName { get; }
-
- public string ShortDisplayTitleResourceName { get; }
-
- public string LongDisplayTitleResourceName { get; }
-
- public string DescriptionResourceName { get; }
-
- public string AccessibleNameResourceName { get; }
-
- public string SearchKeywordsResourceName { get; }
-
- public string GroupName { get; }
-
- public IReadOnlyList<string> Before { get; }
-
- public IReadOnlyList<string> After { get; }
-
- public bool NotSearchable { get; }
-
- public bool NotFavorable { get; }
-
- public bool NoCompactOverlaySupport { get; }
-
- public MenuPlacement? MenuPlacement { get; }
-
- public int? CompactOverlayHeight { get; }
-
- public int? CompactOverlayWidth { get; }
-
- public IReadOnlyList<Platform> TargetPlatforms { get; }
+ internal static GuiToolMetadata Create(
+ string internalComponentName,
+ string author,
+ string iconFontName,
+ string iconGlyph,
+ string groupName,
+ string shortDisplayTitleResourceName,
+ string longDisplayTitleResourceName,
+ string resourceManagerAssemblyIdentifier,
+ string resourceManagerBaseName)
+ {
+ return new GuiToolMetadata(
+ new Dictionary<string, object>
+ {
+ { nameof(NameAttribute.InternalComponentName), "NoSearchResult" },
+ { nameof(AuthorAttribute.Author), "DevToys" },
+ { nameof(ToolDisplayInformationAttribute.IconFontName), "FluentSystemIcons" },
+ { nameof(ToolDisplayInformationAttribute.IconGlyph), "\uF3E9" },
+ { nameof(ToolDisplayInformationAttribute.GroupName), "N/A" },
+ { nameof(ToolDisplayInformationAttribute.ShortDisplayTitleResourceName), "N/A" },
+ { nameof(ToolDisplayInformationAttribute.LongDisplayTitleResourceName), nameof(MainWindow.SearchNoResultsFound) },
+ { nameof(ToolDisplayInformationAttribute.ResourceManagerAssemblyIdentifier), nameof(DevToysLocalizationResourceManagerAssemblyIdentifier) },
+ { nameof(ToolDisplayInformationAttribute.ResourceManagerBaseName), "DevToys.Localization.Strings.MainWindow.MainWindow" }
+ });
+ }
public GuiToolMetadata(IDictionary<string, object> metadata)
{
@@ -119,4 +105,46 @@ public sealed class GuiToolMetadata : IOrderableMetadata
After = after;
}
}
+
+ public string InternalComponentName { get; }
+
+ public string Author { get; }
+
+ public string IconFontName { get; }
+
+ public string IconGlyph { get; }
+
+ public string ResourceManagerAssemblyIdentifier { get; }
+
+ public string ResourceManagerBaseName { get; }
+
+ public string ShortDisplayTitleResourceName { get; }
+
+ public string LongDisplayTitleResourceName { get; }
+
+ public string DescriptionResourceName { get; }
+
+ public string AccessibleNameResourceName { get; }
+
+ public string SearchKeywordsResourceName { get; }
+
+ public string GroupName { get; }
+
+ public IReadOnlyList<string> Before { get; }
+
+ public IReadOnlyList<string> After { get; }
+
+ public bool NotSearchable { get; }
+
+ public bool NotFavorable { get; }
+
+ public bool NoCompactOverlaySupport { get; }
+
+ public MenuPlacement? MenuPlacement { get; }
+
+ public int? CompactOverlayHeight { get; }
+
+ public int? CompactOverlayWidth { get; }
+
+ public IReadOnlyList<Platform> TargetPlatforms { get; }
}
diff --git a/src/app/dev/DevToys.Core/Tools/ViewItems/GuiToolViewItem.cs b/src/app/dev/DevToys.Core/Tools/ViewItems/GuiToolViewItem.cs
index c5682ddab..af63bd4c6 100644
--- a/src/app/dev/DevToys.Core/Tools/ViewItems/GuiToolViewItem.cs
+++ b/src/app/dev/DevToys.Core/Tools/ViewItems/GuiToolViewItem.cs
@@ -11,10 +11,11 @@ public sealed partial class GuiToolViewItem : ObservableObject
{
private readonly bool _showLongDisplayTitle;
- public GuiToolViewItem(GuiToolInstance instance, bool showLongDisplayTitle = true)
+ public GuiToolViewItem(GuiToolInstance instance, bool showLongDisplayTitle = true, MatchSpan[]? matchSpans = null)
{
Guard.IsNotNull(instance);
ToolInstance = instance;
+ MatchedSpans = matchSpans;
_showLongDisplayTitle = showLongDisplayTitle;
}
diff --git a/src/app/dev/DevToys.Localization/DevToys.Localization.csproj b/src/app/dev/DevToys.Localization/DevToys.Localization.csproj
index a3797ecc3..f0fb95632 100644
--- a/src/app/dev/DevToys.Localization/DevToys.Localization.csproj
+++ b/src/app/dev/DevToys.Localization/DevToys.Localization.csproj
@@ -46,4 +46,7 @@
<ItemGroup>
<Analyzer Include="$(RepoRoot)src\generators\ResxHelperGenerator\bin\netstandard2.0\ResxHelperGenerator.dll" />
</ItemGroup>
+ <ItemGroup>
+ <ProjectReference Include="..\DevToys.Api\DevToys.Api.csproj" />
+ </ItemGroup>
</Project>
\ No newline at end of file
diff --git a/src/app/dev/DevToys.Localization/DevToysLocalizationResourceManagerAssemblyIdentifier.cs b/src/app/dev/DevToys.Localization/DevToysLocalizationResourceManagerAssemblyIdentifier.cs
new file mode 100644
index 000000000..27a7b8d20
--- /dev/null
+++ b/src/app/dev/DevToys.Localization/DevToysLocalizationResourceManagerAssemblyIdentifier.cs
@@ -0,0 +1,9 @@
+using DevToys.Api;
+
+namespace DevToys.Localization;
+
+[Export(typeof(IResourceManagerAssemblyIdentifier))]
+[Name(nameof(DevToysLocalizationResourceManagerAssemblyIdentifier))]
+public sealed class DevToysLocalizationResourceManagerAssemblyIdentifier : IResourceManagerAssemblyIdentifier
+{
+}
diff --git a/src/app/dev/DevToys.Localization/Strings/MainWindow/MainWindow.Designer.cs b/src/app/dev/DevToys.Localization/Strings/MainWindow/MainWindow.Designer.cs
index 7446a9cf0..99ccbd89c 100644
--- a/src/app/dev/DevToys.Localization/Strings/MainWindow/MainWindow.Designer.cs
+++ b/src/app/dev/DevToys.Localization/Strings/MainWindow/MainWindow.Designer.cs
@@ -96,6 +96,15 @@ namespace DevToys.Localization.Strings.MainWindow {
}
}
+ /// <summary>
+ /// Looks up a localized string similar to No results found.
+ /// </summary>
+ public static string SearchNoResultsFound {
+ get {
+ return ResourceManager.GetString("SearchNoResultsFound", resourceCulture);
+ }
+ }
+
/// <summary>
/// Looks up a localized string similar to Toggle keep the window on top (Ctrl+Up).
/// </summary>
diff --git a/src/app/dev/DevToys.Localization/Strings/MainWindow/MainWindow.resx b/src/app/dev/DevToys.Localization/Strings/MainWindow/MainWindow.resx
index 7a52baead..6dc378257 100644
--- a/src/app/dev/DevToys.Localization/Strings/MainWindow/MainWindow.resx
+++ b/src/app/dev/DevToys.Localization/Strings/MainWindow/MainWindow.resx
@@ -129,6 +129,9 @@
<data name="Search" xml:space="preserve">
<value>Type to search for tools...</value>
</data>
+ <data name="SearchNoResultsFound" xml:space="preserve">
+ <value>No results found</value>
+ </data>
<data name="ToggleCompactOverlayTooltip" xml:space="preserve">
<value>Toggle keep the window on top (Ctrl+Up)</value>
</data>
diff --git a/src/app/dev/DevToys.UI.Framework/Converters/NullToVisibilityConverter.cs b/src/app/dev/DevToys.UI.Framework/Converters/NullToVisibilityConverter.cs
new file mode 100644
index 000000000..9366486d3
--- /dev/null
+++ b/src/app/dev/DevToys.UI.Framework/Converters/NullToVisibilityConverter.cs
@@ -0,0 +1,42 @@
+using Microsoft.UI.Xaml;
+using Microsoft.UI.Xaml.Data;
+
+namespace DevToys.UI.Framework.Converters;
+
+/// <summary>
+/// Converts a null value to a <see cref="Visibility"/> value.
+/// </summary>
+public sealed class NullToVisibilityConverter : IValueConverter
+{
+ /// <summary>
+ /// Gets or sets the <see cref="Visibility"/> when the input is null.
+ /// </summary>
+ public Visibility VisibilityIfNull { get; set; }
+
+ /// <summary>
+ /// Gets or sets the <see cref="Visibility"/> when the input is null.
+ /// </summary>
+ public Visibility VisibilityIfNotNull { get; set; }
+
+ public bool EnforceNonWhiteSpaceString { get; set; }
+
+ public object Convert(object value, Type targetType, object parameter, string language)
+ {
+ if (value?.GetType() == typeof(string))
+ {
+ if (EnforceNonWhiteSpaceString)
+ {
+ return string.IsNullOrWhiteSpace((string)value) ? VisibilityIfNull : VisibilityIfNotNull;
+ }
+
+ return string.IsNullOrEmpty((string)value) ? VisibilityIfNull : VisibilityIfNotNull;
+ }
+
+ return value == null ? VisibilityIfNull : VisibilityIfNotNull;
+ }
+
+ public object ConvertBack(object value, Type targetType, object parameter, string language)
+ {
+ throw new NotImplementedException();
+ }
+}
diff --git a/src/app/dev/DevToys.UI.Framework/Extensions/HighlighterExtension.cs b/src/app/dev/DevToys.UI.Framework/Extensions/HighlighterExtension.cs
new file mode 100644
index 000000000..06075cdae
--- /dev/null
+++ b/src/app/dev/DevToys.UI.Framework/Extensions/HighlighterExtension.cs
@@ -0,0 +1,82 @@
+using DevToys.Api;
+using Microsoft.UI;
+using Microsoft.UI.Xaml;
+using Microsoft.UI.Xaml.Controls;
+using Microsoft.UI.Xaml.Documents;
+using Microsoft.UI.Xaml.Markup;
+using Microsoft.UI.Xaml.Media;
+using Windows.UI;
+
+namespace DevToys.UI.Framework.Extensions;
+
+[MarkupExtensionReturnType(ReturnType = typeof(IList<TextHighlighter>))]
+[Microsoft.UI.Xaml.Data.Bindable]
+public sealed class HighlighterExtension : MarkupExtension
+{
+ /// <summary>
+ /// Identifies the KeyboardAccelerator attachted property. This enables animation, styling, binding, etc...
+ /// </summary>
+ public static readonly DependencyProperty HighlightersProperty
+ = DependencyProperty.RegisterAttached(
+ "Highlighters",
+ typeof(MatchSpan[]),
+ typeof(HighlighterExtension),
+ new PropertyMetadata(Array.Empty<MatchSpan>(), OnHighlightersChanged));
+
+ /// <summary>
+ /// Gets the value of the Highlighters attached property from the specified FrameworkElement.
+ /// </summary>
+ public static object GetHighlighters(DependencyObject obj)
+ {
+ return obj.GetValue(HighlightersProperty);
+ }
+
+ /// <summary>
+ /// Sets the value of the Highlighters attached property to the specified FrameworkElement.
+ /// </summary>
+ /// <param name="obj">The object on which to set the KeyboardAccelerator attached property.</param>
+ /// <param name="value">The property value to set.</param>
+ public static void SetHighlighters(DependencyObject obj, object value)
+ {
+ obj.SetValue(HighlightersProperty, value);
+ }
+
+ /// <summary>
+ /// Highlighters changed handler.
+ /// </summary>
+ /// <param name="d">FrameworkElement that changed its KeyboardAccelerator attached property.</param>
+ /// <param name="e">DependencyPropertyChangedEventArgs with the new and old value.</param>
+ private static void OnHighlightersChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
+ {
+ if (d is RichTextBlock source)
+ {
+ var value = e.NewValue as MatchSpan[];
+ source.TextHighlighters.Clear();
+
+ if (value is not null && value.Length > 0)
+ {
+ ElementTheme currentTheme = source.ActualTheme;
+ string? highlighterBackgroundResourceName = currentTheme == ElementTheme.Light ? "SystemAccentColorLight2" : "SystemAccentColorDark1";
+ Color highlighterForegroundColor = currentTheme == ElementTheme.Light ? Colors.Black : Colors.White;
+
+ var highlighter = new TextHighlighter()
+ {
+ Background = new SolidColorBrush((Color)Application.Current.Resources[highlighterBackgroundResourceName]),
+ Foreground = new SolidColorBrush(highlighterForegroundColor)
+ };
+
+ for (int i = 0; i < value.Length; i++)
+ {
+ highlighter.Ranges.Add(
+ new TextRange
+ {
+ StartIndex = value[i].StartPosition,
+ Length = value[i].Length
+ });
+ }
+
+ source.TextHighlighters.Add(highlighter);
+ }
+ }
+ }
+}
diff --git a/src/app/dev/DevToys.UI/ViewModels/MainWindowViewModel.cs b/src/app/dev/DevToys.UI/ViewModels/MainWindowViewModel.cs
index 1fd9db0c7..6ef868438 100644
--- a/src/app/dev/DevToys.UI/ViewModels/MainWindowViewModel.cs
+++ b/src/app/dev/DevToys.UI/ViewModels/MainWindowViewModel.cs
@@ -1,8 +1,11 @@
using System.Collections.ObjectModel;
using CommunityToolkit.Mvvm.ComponentModel;
using CommunityToolkit.Mvvm.Input;
+using DevToys.Api.Core;
using DevToys.Core.Tools;
using DevToys.Core.Tools.ViewItems;
+using FuzzySharp;
+using Microsoft.UI.Xaml.Controls;
namespace DevToys.UI.ViewModels;
@@ -100,6 +103,46 @@ internal sealed partial class MainWindowViewModel : ObservableRecipient
/// </summary>
internal bool IsSelectedMenuItemATool => SelectedMenuItem is GuiToolViewItem;
+ // Can't use CommunityToolkit.MVVM due to https://github.com/dotnet/roslyn/issues/57239#issuecomment-1437895948
+ /// <summary>
+ /// Gets or sets the search query typed by the user.
+ /// </summary>
+ internal string SearchQuery { get; set; } = string.Empty;
+
+ /// <summary>
+ /// Gets or sets the list of search results from the <see cref="SearchQuery"/>.
+ /// </summary>
+ [ObservableProperty]
+ private ObservableCollection<GuiToolViewItem> _searchResults = new();
+
+ [RelayCommand]
+ private void SearchBoxTextChanged(AutoSuggestBoxTextChangedEventArgs parameters)
+ {
+ // Since selecting an item will also change the text,
+ // only listen to changes caused by user entering text.
+ if (parameters.Reason == AutoSuggestionBoxTextChangeReason.UserInput)
+ {
+ _guiToolProvider.SearchTools(SearchQuery, SearchResults);
+ }
+ }
+
+ [RelayCommand]
+ private void SearchBoxQuerySubmitted(AutoSuggestBoxQuerySubmittedEventArgs parameters)
+ {
+ var selectedApp = parameters.ChosenSuggestion as GuiToolViewItem;
+ if (selectedApp is null && SearchResults.Count > 0)
+ {
+ selectedApp = SearchResults[0];
+ }
+
+ if (selectedApp is null || selectedApp == GuiToolProvider.NoResultFoundItem)
+ {
+ return;
+ }
+
+ // TODO: Navigate to the tool.
+ }
+
/// <summary>
/// Toggles the favorite status of the <see cref="SelectedMenuItem"/>.
/// </summary>
diff --git a/src/app/dev/DevToys.UI/Views/MainWindow.xaml b/src/app/dev/DevToys.UI/Views/MainWindow.xaml
index 4de26ae06..4acaa621b 100644
--- a/src/app/dev/DevToys.UI/Views/MainWindow.xaml
+++ b/src/app/dev/DevToys.UI/Views/MainWindow.xaml
@@ -17,6 +17,7 @@
xmlns:muxc="using:Microsoft.UI.Xaml.Controls"
xmlns:ix="using:Microsoft.Xaml.Interactions.Core"
xmlns:i="using:Microsoft.Xaml.Interactivity"
+ xmlns:ex="using:DevToys.UI.Framework.Extensions"
mc:Ignorable="d wasm not_win macos ios">
<Page.Resources>
<!--This top margin is the height of the custom TitleBar-->
@@ -24,7 +25,14 @@
<Thickness x:Key="NavigationViewContentGridBorderThickness">1,1,0,0</Thickness>
<CornerRadius x:Key="NavigationViewContentGridCornerRadius">8,0,0,0</CornerRadius>
- <converters:BooleanToPathConverter x:Key="BooleanToCompactModeIconPath" PathIfFalse="{StaticResource EnterCompactOverlayPathIconData}" PathIfTrue="{StaticResource ExitCompactOverlayPathIconData}"/>
+ <converters:BooleanToPathConverter
+ x:Key="BooleanToCompactModeIconPath"
+ PathIfFalse="{StaticResource EnterCompactOverlayPathIconData}"
+ PathIfTrue="{StaticResource ExitCompactOverlayPathIconData}"/>
+ <converters:NullToVisibilityConverter
+ x:Key="CollapsedWhenNullConverter"
+ VisibilityIfNull="Collapsed"
+ VisibilityIfNotNull="Visible"/>
</Page.Resources>
<Grid not_win:Background="{ThemeResource ApplicationPageBackgroundThemeBrush}" ios:Margin="0,38,0,0">
@@ -128,37 +136,53 @@
QueryIcon="Find"
HorizontalAlignment="Stretch"
VerticalAlignment="Center"
- PlaceholderText="{x:Bind strings:MainWindow.Search}">
- <!-- TODO -->
- <!--<i:Interaction.Behaviors>
- <ic:EventTriggerBehavior EventName="TextChanged">
- <ic:InvokeCommandAction Command="{x:Bind ViewModel.SearchBoxTextChangedCommand}"/>
- </ic:EventTriggerBehavior>
- <ic:EventTriggerBehavior EventName="QuerySubmitted">
- <ic:InvokeCommandAction Command="{x:Bind ViewModel.SearchBoxQuerySubmittedCommand}"/>
- </ic:EventTriggerBehavior>
- </i:Interaction.Behaviors>-->
+ PlaceholderText="{x:Bind strings:MainWindow.Search}"
+ UpdateTextOnSelect="False"
+ ItemsSource="{x:Bind ViewModel.SearchResults, Mode=OneWay}"
+ Text="{x:Bind ViewModel.SearchQuery, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged}">
+ <i:Interaction.Behaviors>
+ <ix:EventTriggerBehavior EventName="TextChanged">
+ <ix:InvokeCommandAction Command="{x:Bind ViewModel.SearchBoxTextChangedCommand}"/>
+ </ix:EventTriggerBehavior>
+ <ix:EventTriggerBehavior EventName="QuerySubmitted">
+ <ix:InvokeCommandAction Command="{x:Bind ViewModel.SearchBoxQuerySubmittedCommand}"/>
+ </ix:EventTriggerBehavior>
+ </i:Interaction.Behaviors>
<AutoSuggestBox.KeyboardAccelerators>
<KeyboardAccelerator
Key="F"
Modifiers="Control"
Invoked="SearchBoxKeyboardAccelerator_Invoked"/>
</AutoSuggestBox.KeyboardAccelerators>
- <!-- TODO -->
- <!--<AutoSuggestBox.ItemTemplate>
- <DataTemplate x:DataType="tools:ToolProviderViewItem">
- <RichTextBlock
- HorizontalAlignment="Stretch"
- IsTextSelectionEnabled="False"
- TextWrapping="NoWrap"
- TextTrimming="CharacterEllipsis"
- ex:HighlighterExtension.Highlighters="{x:Bind MatchedSpans, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged}">
- <Paragraph>
- <Run Text="{x:Bind ToolProvider.SearchDisplayName}"/>
- </Paragraph>
- </RichTextBlock>
+ <AutoSuggestBox.ItemTemplate>
+ <DataTemplate x:DataType="tools:GuiToolViewItem">
+ <Grid
+ Height="64">
+ <Grid.ColumnDefinitions>
+ <ColumnDefinition Width="Auto"/>
+ <ColumnDefinition Width="*"/>
+ </Grid.ColumnDefinitions>
+ <FontIcon
+ Grid.Column="0"
+ Visibility="{x:Bind ToolInstance.IconGlyph, Converter={StaticResource CollapsedWhenNullConverter}}"
+ FontFamily="{x:Bind ToolInstance.IconFontName, Converter={StaticResource StringToStaticResourceConverter}}"
+ Glyph="{x:Bind ToolInstance.IconGlyph}"/>
+ <RichTextBlock
+ Grid.Column="1"
+ Margin="12,0,0,0"
+ VerticalAlignment="Center"
+ HorizontalAlignment="Stretch"
+ IsTextSelectionEnabled="False"
+ TextWrapping="NoWrap"
+ TextTrimming="CharacterEllipsis"
+ ex:HighlighterExtension.Highlighters="{x:Bind MatchedSpans, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged}">
+ <Paragraph>
+ <Run Text="{x:Bind MenuDisplayTitle}"/>
+ </Paragraph>
+ </RichTextBlock>
+ </Grid>
</DataTemplate>
- </AutoSuggestBox.ItemTemplate>-->
+ </AutoSuggestBox.ItemTemplate>
</AutoSuggestBox>
</NavigationView.AutoSuggestBox>
diff --git a/src/app/dev/DevToys.UI/Views/ToolGroupPage.xaml b/src/app/dev/DevToys.UI/Views/ToolGroupPage.xaml
index 3a9d4626d..9fcb56577 100644
--- a/src/app/dev/DevToys.UI/Views/ToolGroupPage.xaml
+++ b/src/app/dev/DevToys.UI/Views/ToolGroupPage.xaml
@@ -208,7 +208,7 @@
<StackPanel
Grid.Column="2"
Grid.Row="0"
- Margin="4,0,0,0"
+ Margin="16,0,0,0"
VerticalAlignment="Top"
Orientation="Horizontal"
Spacing="4">