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

CmdPal: Fix selection desync when clearing search query (#45949)

Browse Source 
## Summary of the Pull Request

A single search-text change produces multiple ItemsUpdated callbacks. A
later soft update (ForceFirstItem=false) could overwrite the prior
force-first intent, restoring a stale sticky selection.

- Adds latched _forceFirstPending flag that survives across successive
ItemsUpdated passes until selection stabilizes or user navigates;
- Fixes scroll position on first-item reselection via UpdateLayout +
ScrollToItem + ResetScrollToTop in the deferred callback.

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

- [x] Closes: #45948 
<!-- - [ ] 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
This commit is contained in:
Jiří Polášek
2026-03-09 20:12:53 +01:00
committed by GitHub
parent d1605640ca
commit a130969d0a
1 changed files with 53 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
src/modules/cmdpal/Microsoft.CmdPal.UI/ExtViews/ListPage.xaml.cs
View File

@@ -43,6 +43,13 @@ public sealed partial class ListPage : Page,
private ListItemViewModel? _stickySelectedItem;
private ListItemViewModel? _lastPushedToVm;
// A single search-text change can produce multiple ItemsUpdated calls
// dispatched as separate UI-thread callbacks. A later "soft" update
// (ForceFirstItem = false) must not overwrite a prior force-first
// intent. This flag latches true whenever any update requests
// force-first and is only cleared once selection stabilizes.
private bool _forceFirstPending;
internal ListViewModel? ViewModel
{
get => (ListViewModel?)GetValue(ViewModelProperty);
@@ -224,6 +231,10 @@ public sealed partial class ListPage : Page,
_stickySelectedItem = li;
// User explicitly changed selection — any pending force-first intent
// is superseded by the user's navigation.
_forceFirstPending = false;
// Do not Task.Run (it reorders selection updates).
vm?.UpdateSelectedItemCommand.Execute(li);
@@ -606,10 +617,12 @@ public sealed partial class ListPage : Page,
if (e.NewValue is ListViewModel page)
{
@this._forceFirstPending = false;
page.ItemsUpdated += @this.Page_ItemsUpdated;
}
else if (e.NewValue is null)
{
@this._forceFirstPending = false;
Logger.LogDebug("cleared view model");
}
}
@@ -620,25 +633,32 @@ public sealed partial class ListPage : Page,
private void Page_ItemsUpdated(ListViewModel sender, ItemsUpdatedEventArgs args)
{
var version = Interlocked.Increment(ref _itemsUpdatedVersion);
var forceFirstItem = args.ForceFirstItem;
// Latch: once any update requests force-first, keep it until consumed.
_forceFirstPending |= args.ForceFirstItem;
var forceFirstItem = _forceFirstPending;
// Try to handle selection immediately — items should already be available
// since FilteredItems is a direct ObservableCollection bound as ItemsSource.
if (!TrySetSelectionAfterUpdate(sender, version, forceFirstItem))
// TrySetSelectionAfterUpdate clears _forceFirstPending internally once
// selection stabilizes (no repair needed), so we don't clear it here.
if (TrySetSelectionAfterUpdate(sender, version, forceFirstItem))
{
// Fallback: binding hasn't propagated yet, defer to next tick.
_ = DispatcherQueue.TryEnqueue(
Microsoft.UI.Dispatching.DispatcherQueuePriority.Low,
() =>
{
if (version != Volatile.Read(ref _itemsUpdatedVersion))
{
return;
}
TrySetSelectionAfterUpdate(sender, version, forceFirstItem);
});
return;
}
// Fallback: binding hasn't propagated yet, defer to next tick.
_ = DispatcherQueue.TryEnqueue(
Microsoft.UI.Dispatching.DispatcherQueuePriority.Low,
() =>
{
if (version != Volatile.Read(ref _itemsUpdatedVersion))
{
return;
}
TrySetSelectionAfterUpdate(sender, version, forceFirstItem);
});
}
/// <summary>
@@ -722,13 +742,18 @@ public sealed partial class ListPage : Page,
using (SuppressSelectionChangedScope())
{
ListItemViewModel? stickyRestored = null;
ListItemViewModel? firstSelected = null;
if (!forceFirstItem &&
_stickySelectedItem is not null &&
items.Contains(_stickySelectedItem) &&
!IsSeparator(_stickySelectedItem))
{
// Preserve sticky selection for nested dynamic updates.
// Restore sticky selection only when force-first is not
// active. The latched _forceFirstPending flag guarantees
// that a prior force-first intent survives superseding
// soft updates, so we never accidentally restore a stale
// sticky item when the list was meant to reset.
ItemView.SelectedItem = _stickySelectedItem;
stickyRestored = _stickySelectedItem;
}
@@ -736,6 +761,7 @@ public sealed partial class ListPage : Page,
{
// Select the first interactive item.
ItemView.SelectedItem = items[firstUsefulIndex];
firstSelected = ItemView.SelectedItem as ListItemViewModel;
}
// Prevent any pending "scroll on selection" logic from fighting this.
@@ -748,10 +774,17 @@ public sealed partial class ListPage : Page,
return;
}
ItemView.UpdateLayout();
if (stickyRestored is not null)
{
ScrollToItem(stickyRestored);
}
else if (firstSelected is not null)
{
ScrollToItem(firstSelected);
ResetScrollToTop();
}
else
{
ResetScrollToTop();
@@ -761,7 +794,11 @@ public sealed partial class ListPage : Page,
}
else
{
// Selection is valid and unchanged, just make sure the item is visible
// Selection is valid and unchanged: the force-first intent (if any)
// has been fully delivered and selection has stabilized. Safe to clear.
_forceFirstPending = false;
// Just make sure the item is visible
if (_stickySelectedItem is ListItemViewModel li)
{
_ = DispatcherQueue.TryEnqueue(Microsoft.UI.Dispatching.DispatcherQueuePriority.Low, () =>