mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-02-23 19:49:43 +01:00
## Summary of the Pull Request This PR adds a cache of command provider information so we can show providers even when the command provider isn’t loaded. It also updates the description for disabled extensions on the Extensions page to always include the extension name. Finally, it adds a placeholder icon for cases where an extension icon isn’t loaded. Note that this doesn’t address fully transparent icons that some extensions may inherit from the default template. Before: <img width="1883" height="167" alt="image" src="https://github.com/user-attachments/assets/7ccaa669-9516-4b57-9646-4e755d29d75c" /> After: <img width="1873" height="190" alt="image" src="https://github.com/user-attachments/assets/f29549c2-ddd5-4688-ba9c-d1abd4b523a0" /> <!-- Please review the items on the PR checklist before submitting--> ## PR Checklist - [ ] Closes: #xxx <!-- - [ ] Closes: #yyy (add separate lines for additional resolved issues) --> - [ ] **Communication:** I've discussed this with core contributors already. If the work hasn't been agreed, this work might be rejected - [ ] **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
217 lines
6.9 KiB
C#
217 lines
6.9 KiB
C#
// 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.Diagnostics.CodeAnalysis;
|
|
using CommunityToolkit.Mvvm.ComponentModel;
|
|
using CommunityToolkit.Mvvm.Messaging;
|
|
using Microsoft.CmdPal.Core.Common.Services;
|
|
using Microsoft.CmdPal.Core.ViewModels;
|
|
using Microsoft.CmdPal.UI.ViewModels.Messages;
|
|
using Microsoft.CmdPal.UI.ViewModels.Properties;
|
|
|
|
namespace Microsoft.CmdPal.UI.ViewModels;
|
|
|
|
public partial class ProviderSettingsViewModel : ObservableObject
|
|
{
|
|
private static readonly IconInfoViewModel EmptyIcon = new(null);
|
|
|
|
private readonly CommandProviderWrapper _provider;
|
|
private readonly ProviderSettings _providerSettings;
|
|
private readonly SettingsModel _settings;
|
|
private readonly Lock _initializeSettingsLock = new();
|
|
|
|
private Task? _initializeSettingsTask;
|
|
|
|
public ProviderSettingsViewModel(
|
|
CommandProviderWrapper provider,
|
|
ProviderSettings providerSettings,
|
|
SettingsModel settings)
|
|
{
|
|
_provider = provider;
|
|
_providerSettings = providerSettings;
|
|
_settings = settings;
|
|
|
|
LoadingSettings = _provider.Settings?.HasSettings ?? false;
|
|
|
|
BuildFallbackViewModels();
|
|
}
|
|
|
|
public string DisplayName => _provider.DisplayName;
|
|
|
|
public string ExtensionName => _provider.Extension?.ExtensionDisplayName ?? "Built-in";
|
|
|
|
public string ExtensionSubtext => IsEnabled ?
|
|
HasFallbackCommands ?
|
|
$"{ExtensionName}, {TopLevelCommands.Count} commands, {_provider.FallbackItems?.Length} fallback commands" :
|
|
$"{ExtensionName}, {TopLevelCommands.Count} commands" :
|
|
$"{ExtensionName}, {Resources.builtin_disabled_extension}";
|
|
|
|
[MemberNotNullWhen(true, nameof(Extension))]
|
|
public bool IsFromExtension => _provider.Extension is not null;
|
|
|
|
public IExtensionWrapper? Extension => _provider.Extension;
|
|
|
|
public string ExtensionVersion => IsFromExtension ? $"{Extension.Version.Major}.{Extension.Version.Minor}.{Extension.Version.Build}.{Extension.Version.Revision}" : string.Empty;
|
|
|
|
public IconInfoViewModel Icon => IsEnabled ? _provider.Icon : EmptyIcon;
|
|
|
|
[ObservableProperty]
|
|
public partial bool LoadingSettings { get; set; }
|
|
|
|
public bool IsEnabled
|
|
{
|
|
get => _providerSettings.IsEnabled;
|
|
set
|
|
{
|
|
if (value != _providerSettings.IsEnabled)
|
|
{
|
|
_providerSettings.IsEnabled = value;
|
|
Save();
|
|
WeakReferenceMessenger.Default.Send<ReloadCommandsMessage>(new());
|
|
OnPropertyChanged(nameof(IsEnabled));
|
|
OnPropertyChanged(nameof(ExtensionSubtext));
|
|
OnPropertyChanged(nameof(Icon));
|
|
}
|
|
|
|
if (value == true)
|
|
{
|
|
_provider.CommandsChanged -= Provider_CommandsChanged;
|
|
_provider.CommandsChanged += Provider_CommandsChanged;
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether returns true if we have a settings page
|
|
/// that's initialized, or we are still working on initializing that
|
|
/// settings page. If we don't have a settings object, or that settings
|
|
/// object doesn't have a settings page, then we'll return false.
|
|
/// </summary>
|
|
public bool HasSettings
|
|
{
|
|
get
|
|
{
|
|
if (_provider.Settings is null)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
if (_provider.Settings.Initialized)
|
|
{
|
|
return _provider.Settings.HasSettings;
|
|
}
|
|
|
|
// settings still need to be loaded.
|
|
return LoadingSettings;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets will return the settings page, if we have one, and have initialized it.
|
|
/// If we haven't initialized it, this will kick off a thread to start
|
|
/// initializing it.
|
|
/// </summary>
|
|
public ContentPageViewModel? SettingsPage
|
|
{
|
|
get
|
|
{
|
|
if (_provider.Settings is null)
|
|
{
|
|
return null;
|
|
}
|
|
|
|
if (_provider.Settings.Initialized)
|
|
{
|
|
LoadingSettings = false;
|
|
return _provider.Settings.SettingsPage;
|
|
}
|
|
|
|
// Don't load the settings if we're already working on it
|
|
lock (_initializeSettingsLock)
|
|
{
|
|
_initializeSettingsTask ??= Task.Run(InitializeSettingsPage);
|
|
}
|
|
|
|
return null;
|
|
}
|
|
}
|
|
|
|
[field: AllowNull]
|
|
public List<TopLevelViewModel> TopLevelCommands
|
|
{
|
|
get
|
|
{
|
|
if (field is null)
|
|
{
|
|
field = BuildTopLevelViewModels();
|
|
}
|
|
|
|
return field;
|
|
}
|
|
}
|
|
|
|
private List<TopLevelViewModel> BuildTopLevelViewModels()
|
|
{
|
|
var thisProvider = _provider;
|
|
var providersCommands = thisProvider.TopLevelItems;
|
|
|
|
// Remember! This comes in on the UI thread!
|
|
return [.. providersCommands];
|
|
}
|
|
|
|
[field: AllowNull]
|
|
public List<FallbackSettingsViewModel> FallbackCommands { get; set; } = [];
|
|
|
|
public bool HasFallbackCommands => _provider.FallbackItems?.Length > 0;
|
|
|
|
private void BuildFallbackViewModels()
|
|
{
|
|
var thisProvider = _provider;
|
|
var providersFallbackCommands = thisProvider.FallbackItems;
|
|
|
|
List<FallbackSettingsViewModel> fallbackViewModels = new(providersFallbackCommands.Length);
|
|
foreach (var fallbackItem in providersFallbackCommands)
|
|
{
|
|
if (_providerSettings.FallbackCommands.TryGetValue(fallbackItem.Id, out var fallbackSettings))
|
|
{
|
|
fallbackViewModels.Add(new FallbackSettingsViewModel(fallbackItem, fallbackSettings, _settings, this));
|
|
}
|
|
else
|
|
{
|
|
fallbackViewModels.Add(new FallbackSettingsViewModel(fallbackItem, new(), _settings, this));
|
|
}
|
|
}
|
|
|
|
FallbackCommands = fallbackViewModels;
|
|
}
|
|
|
|
private void Save() => SettingsModel.SaveSettings(_settings);
|
|
|
|
private void InitializeSettingsPage()
|
|
{
|
|
if (_provider.Settings is null)
|
|
{
|
|
return;
|
|
}
|
|
|
|
_provider.Settings.SafeInitializeProperties();
|
|
_provider.Settings.DoOnUiThread(() =>
|
|
{
|
|
// Changing these properties will try to update XAML, and that has
|
|
// to be handled on the UI thread, so we need to raise them on the
|
|
// UI thread
|
|
LoadingSettings = false;
|
|
OnPropertyChanged(nameof(HasSettings));
|
|
OnPropertyChanged(nameof(LoadingSettings));
|
|
OnPropertyChanged(nameof(SettingsPage));
|
|
});
|
|
}
|
|
|
|
private void Provider_CommandsChanged(CommandProviderWrapper sender, CommandPalette.Extensions.IItemsChangedEventArgs args)
|
|
{
|
|
OnPropertyChanged(nameof(ExtensionSubtext));
|
|
OnPropertyChanged(nameof(TopLevelCommands));
|
|
}
|
|
}
|