Skip to content

feat(MultiSelect): add IsVirtualize parameter #5652

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 40 commits into from
Mar 18, 2025
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Mar 18, 2025

Link issues

fixes #5645

Summary By Copilot

This pull request introduces several enhancements to the MultiSelect component in the BootstrapBlazor library, focusing on adding virtualization support and improving the user interface with additional features like clearable options.

Enhancements to MultiSelect component:

Virtualization support:

Clearable option:

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

Adds virtualization support to the MultiSelect component, improving performance with large datasets. Also introduces a clearable option to the MultiSelect and Select components, allowing users to easily clear selected values.

New Features:

  • Adds virtualization support to the MultiSelect component for efficient rendering of large datasets.
  • Adds a clearable option to the MultiSelect and Select components, allowing users to clear selected values.
  • Adds OnQueryAsync parameter for loading virtualized items in MultiSelect component

@bb-auto bb-auto bot added the enhancement New feature or request label Mar 18, 2025
Copy link
Contributor

sourcery-ai bot commented Mar 18, 2025

Reviewer's Guide by Sourcery

This pull request introduces virtualization support and a clearable option to the MultiSelect component. Virtualization is implemented using the Virtualize component and the OnQueryAsync parameter for efficient rendering of large datasets. The clearable option allows users to clear selected values and is implemented with a clearable icon in the dropdown menu. Common properties related to virtualization and clearable options were refactored into the SelectBase class.

Sequence diagram for clearing value in MultiSelect

sequenceDiagram
    participant User
    participant MultiSelect
    User->>MultiSelect: Clicks clear icon
    MultiSelect->>MultiSelect: OnClearValue()
    MultiSelect->>MultiSelect: ClearSearchText()
    MultiSelect->>MultiSelect: Invoke OnClearAsync()
    alt OnQueryAsync is not null
        MultiSelect->>Virtualize: RefreshDataAsync()
    end
    MultiSelect->>MultiSelect: Clear SelectedItems
    MultiSelect-->>User: Updates UI
Loading

File-Level Changes

Change Details Files
Introduced virtualization support to the MultiSelect component, allowing for efficient rendering of large datasets.
  • Added Virtualize component to handle rendering of items.
  • Added OnQueryAsync parameter for loading virtualized items.
  • Implemented methods to handle virtualization.
  • Added a new demo showcasing the virtualization feature with options to toggle search, fixed search, and clearable settings.
src/BootstrapBlazor/Components/Select/MultiSelect.razor
src/BootstrapBlazor/Components/Select/MultiSelect.razor.cs
src/BootstrapBlazor.Server/Components/Samples/MultiSelects.razor
src/BootstrapBlazor.Server/Components/Samples/MultiSelects.razor.cs
Added a clearable option to the MultiSelect component, allowing users to clear selected values.
  • Added logic to manage the clearable state and icon display.
  • Updated the template to include the clearable icon in the dropdown menu.
src/BootstrapBlazor/Components/Select/Select.razor
src/BootstrapBlazor/Components/Select/Select.razor.cs
src/BootstrapBlazor/Components/SelectGeneric/SelectGeneric.razor.cs
src/BootstrapBlazor/Components/Select/SelectBase.cs
Refactored common properties related to virtualization and clearable options into the SelectBase class.
  • Moved IsVirtualize, RowHeight, OverscanCount, DefaultVirtualizeItemText, OnClearAsync, ClearIcon, and IsClearable properties from Select and SelectGeneric components to SelectBase.
  • Added GetClearable method to SelectBase to determine if the clearable option should be displayed.
src/BootstrapBlazor/Components/Select/SelectBase.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5645 Implement virtualization for the MultiSelect component to handle large datasets efficiently.

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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 v9.4.0 milestone Mar 18, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Mar 18, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider extracting the common logic for handling virtualized items into a shared method or base class to avoid duplication between MultiSelect and Select components.
  • The ClearIcon and IsClearable parameters have been moved to SelectBase, so remove them from SelectGeneric as they are inherited.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

codecov bot commented Mar 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (9f1df2b) to head (2f0d6e2).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##              main     #5652    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files          653       654     +1     
  Lines        29387     29571   +184     
  Branches      4197      4207    +10     
==========================================
+ Hits         29387     29571   +184     

☔ View full report in Codecov by Sentry.
📢 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.

@ArgoZhang ArgoZhang merged commit 366c830 into main Mar 18, 2025
3 checks passed
@ArgoZhang ArgoZhang deleted the feat-virtual-multi-select branch March 18, 2025 13:10
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(MultiSelect): add IsVirtualize parameter
1 participant