Mirrors/PowerToys
1
0
Fork 0
mirror of https://github.com/microsoft/PowerToys.git synced 2026-04-06 03:07:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Setting search (#41285)

Browse Source 
<!-- Enter a brief description/summary of your PR here. What does it
fix/what does it change/how was it tested (even manually, if necessary)?
-->
## Summary of the Pull Request

<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist

- [ ] Closes: #xxx
- [ ] **Communication:** I've discussed this with core contributors
already. If the work hasn't been agreed, this work might be rejected
- [x] **Tests:** Added/updated and all pass
- [ ] **Localization:** All end-user-facing strings can be localized
- [ ] **Dev docs:** Added/updated
- [ ] **New binaries:** Added on the required places
- [ ] [JSON for
signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ESRPSigning_core.json)
for new binaries
- [ ] [WXS for
installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs)
for new binaries and localization folder
- [ ] [YML for CI
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ci/templates/build-powertoys-steps.yml)
for new test projects
- [ ] [YML for signed
pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/release.yml)
- [ ] **Documentation updated:** If checked, please file a pull request
on [our docs
repo](https://github.com/MicrosoftDocs/windows-uwp/tree/docs/hub/powertoys)
and link it here: #xxx

<!-- Provide a more detailed description of the PR, other things fixed,
or any additional comments/features here -->
## Detailed Description of the Pull Request / Additional comments

<!-- Describe how you validated the behavior. Add automated tests
wherever possible, but list manual validation steps taken as well -->
## Validation Steps Performed
Localized search:
<img width="1576" height="480" alt="image"
src="https://github.com/user-attachments/assets/dd6e5e9f-419b-40b1-b796-f0799481ecfc"
/>


## AI summary
This pull request introduces infrastructure and code to support search
functionality for PowerToys settings, including a new search index
specification, a dedicated search library, and updates to the solution
configuration. The main changes are the addition of a spec describing
how settings should be indexed and navigated, the creation of a new
`Common.Search` project with a fuzz search implementation, and updates
to the solution file to include these new components.

**Settings Search Feature Implementation**

* Documentation:
* Added a detailed specification (`settings-search.md`) describing the
structure of PowerToys settings pages, how to index settings, navigation
logic, runtime search, result grouping, build-time indexing strategy,
and corner cases.

* New Search Library:
* Added the new `Common.Search` project to the solution, including its
project file and implementation of a fuzz search service
(`FuzzSearchService<T>`), match options, match results, and search
precision scoring.
[[1]](diffhunk://#diff-ddc06fa41e4e723e54181b0cb85cdd00f57f75725d51ceefa242d4d651a9a363R1-R8)
[[2]](diffhunk://#diff-1a2ca29fc33bcccf338a7843a040ca2c31ba821e8cab7064fab0dbb1224d454cR1-R39)
[[3]](diffhunk://#diff-242764d948b795f39653a84d9b6bfcdc52730100deab2e3a0995be95bb8e7868R1-R10)
[[4]](diffhunk://#diff-61e525491ed916ebd65dabb66dd4f5dc720320d7e295ef1e0bd6d506ea0f7df6R1-R67)
[[5]](diffhunk://#diff-a775f6de2e8d42982829b4161668f49dedbbd9dcbb05ce20003de7e62275c57aR1-R12)

* Solution Configuration:
* Updated `PowerToys.sln` to include `Common.Search` and
`Settings.UI.XamlIndexBuilder` projects, and configured their build
settings for various platforms and mapped project dependencies.
[[1]](diffhunk://#diff-ca837ce490070b91656ffffe31cbad8865ba9174e0f020231f77baf35ff3f811R714-R716)
[[2]](diffhunk://#diff-ca837ce490070b91656ffffe31cbad8865ba9174e0f020231f77baf35ff3f811R2704-R2727)
[[3]](diffhunk://#diff-ca837ce490070b91656ffffe31cbad8865ba9174e0f020231f77baf35ff3f811R2889)
[[4]](diffhunk://#diff-ca837ce490070b91656ffffe31cbad8865ba9174e0f020231f77baf35ff3f811R3157-R3158)

**Spell-check Dictionary Updates**

* Added new terms related to navigation and settings UI components (such
as `Navigatable`, `NavigatablePage`, `settingscard`, `Tru`, `tweakable`)
to the spell-check dictionary to support the new search and indexing
features.
[[1]](diffhunk://#diff-5dcab162c1b233a49973ae010f2b88c7ec4844382abd705e6154685e62bd5c4dR1020-R1021)
[[2]](diffhunk://#diff-5dcab162c1b233a49973ae010f2b88c7ec4844382abd705e6154685e62bd5c4dR1498)
[[3]](diffhunk://#diff-5dcab162c1b233a49973ae010f2b88c7ec4844382abd705e6154685e62bd5c4dR1755-R1761)

---------

Co-authored-by: Niels Laute <niels.laute@live.nl>
Co-authored-by: Gordon Lam (SH) <yeelam@microsoft.com>
Co-authored-by: Gordon Lam <73506701+yeelam-gordon@users.noreply.github.com>
This commit is contained in:
Kai Tao
2025-08-25 21:23:07 +08:00
committed by GitHub
parent 64dc8e0f27
commit 4ad951eb56
99 changed files with 3734 additions and 558 deletions
Download Patch File Download Diff File Expand all files Collapse all files

133
src/settings-ui/Settings.UI/Converters/IconConverter.cs Normal file
View File

@@ -0,0 +1,133 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using Microsoft.UI.Xaml.Controls;
using Microsoft.UI.Xaml.Data;
using Microsoft.UI.Xaml.Markup;
using Microsoft.UI.Xaml.Media;
using Microsoft.UI.Xaml.Media.Imaging;
namespace Microsoft.PowerToys.Settings.UI.Converters
{
public partial class IconConverter : IValueConverter
{
public object Convert(object value, Type targetType, object parameter, string language)
{
if (value is not string iconValue || string.IsNullOrEmpty(iconValue))
{
// Return a default icon based on the parameter
var defaultGlyph = parameter?.ToString() ?? "\uE8B7"; // Default gear icon
return new FontIcon { Glyph = defaultGlyph };
}
// Check if it's a single Unicode character (most common case after JSON deserialization)
if (iconValue.Length == 1)
{
return new FontIcon { Glyph = iconValue };
}
// Handle HTML numeric character references, e.g. "&#xE80F;" or "&#59951;"
if (iconValue.StartsWith("&#", StringComparison.Ordinal) && iconValue.EndsWith(';'))
{
var inner = iconValue.Substring(2, iconValue.Length - 3); // strip &# and ;
try
{
string glyph;
if (inner.StartsWith("x", StringComparison.OrdinalIgnoreCase))
{
var hex = inner.Substring(1);
if (int.TryParse(hex, System.Globalization.NumberStyles.HexNumber, null, out int codePointHex))
{
glyph = char.ConvertFromUtf32(codePointHex);
return new FontIcon { Glyph = glyph };
}
}
else if (int.TryParse(inner, out int codePointDec))
{
glyph = char.ConvertFromUtf32(codePointDec);
return new FontIcon { Glyph = glyph };
}
}
catch
{
// fall through to other handlers
}
}
if (iconValue.StartsWith("\\u", StringComparison.OrdinalIgnoreCase) && iconValue.Length == 6)
{
var hexPart = iconValue.Substring(2); // Remove \u
if (int.TryParse(hexPart, System.Globalization.NumberStyles.HexNumber, null, out int codePoint))
{
var unicodeChar = char.ConvertFromUtf32(codePoint);
return new FontIcon { Glyph = unicodeChar };
}
}
// Check if it's an image path
if (iconValue.Contains('/') || iconValue.Contains('\\') || iconValue.Contains(".png", StringComparison.OrdinalIgnoreCase) || iconValue.Contains(".jpg", StringComparison.OrdinalIgnoreCase) || iconValue.Contains(".ico", StringComparison.OrdinalIgnoreCase) || iconValue.Contains(".svg", StringComparison.OrdinalIgnoreCase))
{
// Handle different path formats
var imagePath = iconValue;
// Convert ms-appx:/// paths to local paths
if (imagePath.StartsWith("ms-appx:///", StringComparison.OrdinalIgnoreCase))
{
imagePath = imagePath.Substring("ms-appx:///".Length);
}
// Ensure path starts with /
if (!imagePath.StartsWith('/'))
{
imagePath = "/" + imagePath;
}
var uri = new Uri($"ms-appx://{imagePath}");
if (imagePath.EndsWith(".svg", StringComparison.OrdinalIgnoreCase))
{
// Render SVG using ImageIcon + SvgImageSource
return new ImageIcon
{
Source = new SvgImageSource(uri),
};
}
else
{
return new BitmapIcon
{
UriSource = uri,
ShowAsMonochrome = false,
};
}
}
// Try to interpret as raw SVG path data (PathIcon.Data)
// Many of our XAML PathIcon usages (e.g., AdvancedPastePage) provide a Data string like "M128 766q0-42 ...".
// If parsing succeeds, render it as a PathIcon.
try
{
var geometryObj = XamlBindingHelper.ConvertValue(typeof(Geometry), iconValue);
if (geometryObj is Geometry geometry)
{
return new PathIcon { Data = geometry };
}
}
catch
{
// Ignore parse errors and fall back below.
}
// If all else fails, return default icon
var fallbackGlyph = parameter?.ToString() ?? "\uE8B7";
return new FontIcon { Glyph = fallbackGlyph };
}
public object ConvertBack(object value, Type targetType, object parameter, string language)
{
throw new NotImplementedException();
}
}
}

40
src/settings-ui/Settings.UI/Converters/SearchSuggestionTemplateSelector.cs Normal file
View File

@@ -0,0 +1,40 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using Microsoft.PowerToys.Settings.UI.Library;
using Microsoft.PowerToys.Settings.UI.ViewModels;
using Microsoft.UI.Xaml;
using Microsoft.UI.Xaml.Controls;
namespace Microsoft.PowerToys.Settings.UI.Converters;
public sealed partial class SearchSuggestionTemplateSelector : DataTemplateSelector
{
public DataTemplate DefaultSuggestionTemplate { get; set; }
public DataTemplate NoResultsSuggestionTemplate { get; set; }
public DataTemplate ShowAllSuggestionTemplate { get; set; }
protected override DataTemplate SelectTemplateCore(object item, DependencyObject container)
{
if (item is SuggestionItem suggestionItem)
{
if (suggestionItem.IsNoResults)
{
return NoResultsSuggestionTemplate;
}
if (suggestionItem.IsShowAll)
{
return ShowAllSuggestionTemplate ?? NoResultsSuggestionTemplate ?? DefaultSuggestionTemplate;
}
return DefaultSuggestionTemplate;
}
return DefaultSuggestionTemplate;
}
}

25
src/settings-ui/Settings.UI/Converters/UriToImageConverter.cs Normal file
View File

@@ -0,0 +1,25 @@
// Copyright (c) Microsoft Corporation
// The Microsoft Corporation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Microsoft.UI.Xaml.Data;
using Microsoft.UI.Xaml.Media.Imaging;
namespace Microsoft.PowerToys.Settings.UI.Converters
{
public sealed partial class UriToImageSourceConverter : IValueConverter
{
public object Convert(object value, Type targetType, object parameter, string language)
{
return value is Uri uri ? new BitmapImage(uri) : null;
}
public object ConvertBack(object value, Type targetType, object parameter, string language)
=> throw new NotImplementedException();
}
}