Skip to content
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

feat(MultiSelect): support Flags attribute #5253

Merged
merged 7 commits into from
Jan 31, 2025
Merged

feat(MultiSelect): support Flags attribute #5253

merged 7 commits into from
Jan 31, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Jan 31, 2025

support Flags attribute

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #5239

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

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

Add support for the Flags attribute to the MultiSelect component.

New Features:

  • Allow selecting multiple enum values using flags in the MultiSelect component.

Tests:

  • Updated existing tests to cover the new Flags attribute functionality.

Copy link

sourcery-ai bot commented Jan 31, 2025

Reviewer's Guide by Sourcery

This pull request introduces support for the Flags attribute in the MultiSelect component, allowing it to handle enums with the Flags attribute. The changes include modifications to the MultiSelect component to correctly process and display selected values for Flags enums, and a new demo showcasing this functionality.

Sequence diagram for MultiSelect Flags enum value setting

sequenceDiagram
    participant User
    participant MultiSelect
    participant EnumSystem

    User->>MultiSelect: Select multiple enum values
    MultiSelect->>EnumSystem: Check for FlagsAttribute
    MultiSelect->>EnumSystem: Parse selected values
    MultiSelect->>MultiSelect: Calculate combined value
    Note over MultiSelect: Sum up enum values<br/>for Flags representation
    MultiSelect->>MultiSelect: Update CurrentValue
Loading

Class diagram showing MultiSelect component changes for Flags support

classDiagram
    class MultiSelect {
      +TValue CurrentValue
      +string CurrentValueAsString
      +List~SelectedItem~ SelectedItems
      -Type ValueType
      +SetValue() Task
      +ResetRules() void
    }
    note for MultiSelect "Added Flags enum support"

    class MultiSelectEnumFoo {
      <<enumeration>>
      One = 1
      Two = 2
      Three = 4
      Four = 8
    }
    note for MultiSelectEnumFoo "New Flags enum for demo"
Loading

File-Level Changes

Change Details Files
Added support for Flags attribute to MultiSelect component.
  • Modified the SetValue method to handle enums with the Flags attribute.
  • The component now correctly parses and sets the selected values for Flags enums.
src/BootstrapBlazor/Components/Select/MultiSelect.razor.cs
Added a new demo for Flags enums in MultiSelect component.
  • Added a new DemoBlock to showcase the Flags enum functionality.
  • Added a new enum MultiSelectEnumFoo with the Flags attribute.
  • Added a new property EnumFoo to bind to the MultiSelect component.
src/BootstrapBlazor.Server/Components/Samples/MultiSelects.razor
src/BootstrapBlazor.Server/Components/Samples/MultiSelects.razor.cs
Updated MultiSelect component usage in demos.
  • Updated MultiSelect component usage to use self-closing tags.
src/BootstrapBlazor.Server/Components/Samples/MultiSelects.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#5239 Support MultiSelect binding for Flag-attributed enums, allowing automatic selection of multiple enum values
#5239 Enable MultiSelect to work seamlessly with enums that have the [Flag] attribute, such as binding a combined enum value (e.g., EnumEducation.Primary EnumEducation.Middle)
#5239 Demonstrate the functionality with a sample Flag enum in the component's demo

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!
  • 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 the enhancement New feature or request label Jan 31, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Jan 31, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jan 31, 2025
Copy link

@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 and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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.

src/BootstrapBlazor/Components/Select/MultiSelect.razor.cs Outdated Show resolved Hide resolved
Copy link

codecov bot commented Jan 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (ae7a53c) to head (f816fed).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5253   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          639       639           
  Lines        28733     28752   +19     
  Branches      4080      4084    +4     
=========================================
+ Hits         28733     28752   +19     

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

@ArgoZhang ArgoZhang merged commit 3a219b6 into main Jan 31, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-multi branch January 31, 2025 05:14
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): MultiSelect to support Flag Enum
1 participant