Skip to content

feat(Virtualize): add ItemComparer parameter support NET11 - #8461

Merged
ArgoZhang merged 2 commits into
mainfrom
feat-virtualize
Sep 12, 2026
Merged

feat(Virtualize): add ItemComparer parameter support NET11#8461
ArgoZhang merged 2 commits into
mainfrom
feat-virtualize

Conversation

@ArgoZhang

@ArgoZhang ArgoZhang commented Sep 12, 2026

Copy link
Copy Markdown
Member

Link issues

fixes #8458

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Support stable item comparison in NET11 virtualized controls across selection and tabular components.

New Features:

  • Add NET11 virtualized item comparer support to AutoFill, Select, MultiSelect, generic select, and Table components to preserve item identity when refreshed data contains new instances.

Bug Fixes:

  • Ensure virtualized controls correctly recognize equivalent items from remote data sources based on their identifiers or model equality.

Enhancements:

  • Centralize Virtualize component rendering and reference handling across supported components.
  • Add equality comparers for standard and generic selected items.

Tests:

  • Add NET11 tests covering equality and hash-code behavior for standard and generic selected-item comparers.

@bb-auto bb-auto Bot added the enhancement New feature or request label Sep 12, 2026
@sourcery-ai

sourcery-ai Bot commented Sep 12, 2026

Copy link
Copy Markdown
Contributor

Reviewer's Guide

This PR adds NET11-only ItemComparer support for virtualized AutoFill, select, and table components by centralizing Virtualize rendering and supplying value/model-based comparers, with focused unit tests for comparer semantics.

Sequence diagram for NET11 virtualized rendering

sequenceDiagram
    participant Component as Virtualized component
    participant Helper as VirtualizeHelper.Render
    participant Virtualize as Virtualize
    participant Provider as LoadItems
    participant Comparer as ItemComparer

    Component->>Helper: Render(LoadItems, RenderRow, RenderPlaceholderRow, ...)
    Helper->>Virtualize: OpenComponent<Virtualize>
    Helper->>Virtualize: AddAttribute(ItemsProvider)
    Helper->>Virtualize: AddAttribute(ItemComparer)
    Helper->>Component: Capture Virtualize reference
    Virtualize->>Provider: ItemsProvider request
    Virtualize->>Comparer: Compare virtualized items
Loading

Entity relationship diagram for virtualized item identity

erDiagram
    VIRTUALIZED_ITEM {
        value identity_key
    }
    ITEM_COMPARER {
        equality_semantics value_or_model
    }
    VIRTUALIZED_ITEM }o--|| ITEM_COMPARER : compared_by
Loading

File-Level Changes

Change Details Files
Added NET11-only comparer support to virtualized component rendering.
  • Exposed ItemComparer on AutoFill.
  • Passed comparer instances into Select, MultiSelect, generic select, and Table virtualization.
  • Preserved existing target-framework behavior with conditional compilation.
src/BootstrapBlazor/Components/AutoFill/AutoFill.razor.cs
src/BootstrapBlazor/Components/AutoFill/AutoFill.razor
src/BootstrapBlazor/Components/Select/Select.razor
src/BootstrapBlazor/Components/Select/Select.razor.cs
src/BootstrapBlazor/Components/Select/MultiSelect.razor
src/BootstrapBlazor/Components/Select/MultiSelect.razor.cs
src/BootstrapBlazor/Components/Select/SimpleSelectBase.cs
src/BootstrapBlazor/Components/SelectGeneric/SelectGeneric.razor
src/BootstrapBlazor/Components/SelectGeneric/SelectGeneric.razor.cs
src/BootstrapBlazor/Components/SelectGeneric/MultiSelectGeneric.razor
src/BootstrapBlazor/Components/SelectGeneric/MultiSelectGeneric.razor.cs
src/BootstrapBlazor/Components/Table/Table.razor
src/BootstrapBlazor/Components/Table/Table.razor.cs
Centralized Virtualize component construction to attach framework-specific comparer parameters while retaining component references.
  • Introduced a shared RenderFragment helper for virtualization attributes, providers, templates, sizing, overscan, comparer, and references.
  • Replaced inline Virtualize markup across affected components with the helper.
src/BootstrapBlazor/Components/Virtualization/VirtualizeHelper.cs
src/BootstrapBlazor/Components/AutoFill/AutoFill.razor.cs
src/BootstrapBlazor/Components/Select/Select.razor.cs
src/BootstrapBlazor/Components/Select/MultiSelect.razor.cs
src/BootstrapBlazor/Components/SelectGeneric/SelectGeneric.razor.cs
src/BootstrapBlazor/Components/SelectGeneric/MultiSelectGeneric.razor.cs
src/BootstrapBlazor/Components/Table/Table.razor.cs
Implemented identity comparers for virtualized selected items and model-backed items.
  • Compare non-generic selected items by value.
  • Compare generic selected items through the component's model equality comparer.
  • Cache comparer instances per component where needed.
src/BootstrapBlazor/Components/Misc/SelectedItemComparer.cs
src/BootstrapBlazor/Components/Select/SimpleSelectBase.cs
src/BootstrapBlazor/Components/SelectGeneric/SelectGeneric.razor.cs
src/BootstrapBlazor/Components/SelectGeneric/MultiSelectGeneric.razor.cs
src/BootstrapBlazor/Components/Table/Table.razor.cs
Added NET11-gated unit coverage for comparer equality and hash-code behavior.
  • Verified null, reference, identifier, and differing-value cases.
  • Verified generic model equality and null hash-code handling.
test/UnitTest/Misc/SelectedItemComparerTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#8458 Add support for passing an ItemComparer to virtualized components when targeting .NET 11 or later.
#8458 Apply appropriate item comparers to the affected virtualized components, including AutoFill, Select variants, and Table, so items returned as new instances can be matched by identity or model equality.
#8458 Provide comparer implementations and automated tests for the virtualized selected-item comparison behavior.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto Bot added this to the v10.10.0 milestone Sep 12, 2026

@bb-auto bb-auto Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Auto approved by bb-auto

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

@codecov

codecov Bot commented Sep 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (80d96ad) to head (6e1a5ac).

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #8461   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          776       777    +1     
  Lines        35069     35098   +29     
=========================================
+ Hits         35069     35098   +29     
Flag Coverage Δ
BB 100.00% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@bb-auto bb-auto Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Auto approved by bb-auto

@ArgoZhang
ArgoZhang merged commit 1f49b39 into main Sep 12, 2026
7 checks passed
@ArgoZhang
ArgoZhang deleted the feat-virtualize branch September 12, 2026 12:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(Virtualize): add ItemComparer parameter support NET11

1 participant