Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Dec 21, 2024

add CheckboxListGeneric component

Summary of the changes (Less than 80 chars)

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

Description

fixes #4904

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

New Features:

  • Introduce the CheckboxListGeneric component, enabling users to select multiple items from a list of generic types.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Dec 21, 2024

Reviewer's Guide by Sourcery

This pull request introduces the CheckboxListGeneric component, a new component for displaying a list of checkboxes. It addresses issue #4904 and includes a demo and updated documentation.

Sequence diagram for checkbox state change handling

sequenceDiagram
    participant User
    participant CheckboxListGeneric
    participant Checkbox
    participant OnSelectedChanged

    User->>CheckboxListGeneric: Click checkbox
    CheckboxListGeneric->>Checkbox: OnClick(item)
    alt MaxSelectedCount > 0
        CheckboxListGeneric->>CheckboxListGeneric: OnBeforeStateChanged check
        alt count >= MaxSelectedCount
            CheckboxListGeneric-->>OnSelectedChanged: OnMaxSelectedCountExceed
            CheckboxListGeneric-->>User: Prevent selection
        end
    end
    CheckboxListGeneric->>CheckboxListGeneric: OnStateChanged(item, value)
    CheckboxListGeneric->>CheckboxListGeneric: Update CurrentValue
    alt OnSelectedChanged exists
        CheckboxListGeneric->>OnSelectedChanged: Notify selection change
    else
        CheckboxListGeneric->>CheckboxListGeneric: StateHasChanged
    end
Loading

File-Level Changes

Change Details Files
Added the CheckboxListGeneric component.
  • Created the CheckboxListGeneric component for displaying a list of checkboxes with generic type support.
  • Implemented the UI for the component, including both button and standard checkbox styles.
  • Added unit tests to ensure the component functions correctly.
  • Added support for key attributes and custom equality comparers for model comparison.
  • Implemented features such as disabling checkboxes, vertical layout, and a maximum selection count.
  • Added event handling for selection changes and exceeding the maximum selection count.
  • Added support for required validation and localization.
src/BootstrapBlazor/Components/Checkbox/CheckboxListGeneric.razor
src/BootstrapBlazor/Components/Checkbox/CheckboxListGeneric.razor.cs
test/UnitTest/Components/CheckboxListGenericTest.cs
Integrated the CheckboxListGeneric component into the sample application.
  • Added a demo for the CheckboxListGeneric component to the CheckboxLists sample page.
  • Initialized the component with sample data and localized text.
  • Displayed the selected items in the demo section.
src/BootstrapBlazor.Server/Components/Samples/CheckboxLists.razor
src/BootstrapBlazor.Server/Components/Samples/CheckboxLists.razor.cs
Added a unique key to each checkbox item in the CheckboxList component.
  • Added the @key attribute to each checkbox item in the CheckboxList component to improve rendering efficiency and prevent potential issues with component re-rendering.
src/BootstrapBlazor/Components/Checkbox/CheckboxList.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#4904 Add a new CheckboxListGeneric component

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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 Dec 21, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Dec 21, 2024
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 and they look great!

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

@codecov
Copy link

codecov bot commented Dec 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@            Coverage Diff             @@
##              main     #4905    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files          624       626     +2     
  Lines        27870     27994   +124     
  Branches      4001      4021    +20     
==========================================
+ Hits         27870     27994   +124     

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

@ArgoZhang ArgoZhang merged commit 3cf0a8f into main Dec 21, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the doc-radio-list branch December 21, 2024 02:40
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(CheckboxListGeneric): add CheckboxListGeneric component

2 participants