Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 27, 2025

add ItemTemplate parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #5225

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 an ItemTemplate parameter to CheckboxList and Checkbox components to allow custom rendering of checkbox items.

New Features:

  • Added an ItemTemplate parameter to the CheckboxList component to customize the rendering of individual checkbox items.

Tests:

  • Added unit tests for the new ItemTemplate parameter in CheckboxList and Checkbox components.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 27, 2025

Reviewer's Guide by Sourcery

This pull request introduces the ItemTemplate parameter to the CheckboxList and Checkbox components, allowing users to customize the rendering of individual items.

Class diagram showing the updated CheckboxList and Checkbox components

classDiagram
    class CheckboxList {
        +IEnumerable~SelectedItem~ Items
        +RenderFragment~SelectedItem~ ItemTemplate
        +GetChildContent(SelectedItem item)
    }
    class Checkbox {
        +RenderFragment ChildContent
        +bool StopPropagation
        +string DisplayText
    }
    class SelectedItem {
        +string Text
        +bool Active
    }
    class IconSelectedItem {
        +string Icon
    }
    CheckboxList ..> Checkbox : uses
    CheckboxList ..> SelectedItem : uses
    IconSelectedItem --|> SelectedItem : extends
    note for CheckboxList "Added ItemTemplate parameter"
    note for Checkbox "Added ChildContent parameter"
Loading

File-Level Changes

Change Details Files
Added ItemTemplate parameter to CheckboxList component
  • Added ItemTemplate parameter of type RenderFragment to the CheckboxList component.
  • Modified the CheckboxList component to use the ItemTemplate parameter to render each item if provided.
  • Added a GetChildContent method to handle the rendering of the ItemTemplate.
src/BootstrapBlazor/Components/Checkbox/CheckboxList.razor.cs
src/BootstrapBlazor/Components/Checkbox/CheckboxList.razor
Added ItemTemplate parameter to Checkbox component
  • Added ChildContent parameter of type RenderFragment to the Checkbox component.
  • Modified the Checkbox component to use the ChildContent parameter to render the label content if provided.
src/BootstrapBlazor/Components/Checkbox/Checkbox.razor.cs
src/BootstrapBlazor/Components/Checkbox/Checkbox.razor
Updated RadioList and Radio components to use ChildContent
  • Modified the RadioList component to use the GetChildContent method to render each item.
  • Removed the ItemTemplate parameter from the RadioList component.
  • Modified the Radio component to use the ChildContent parameter to render the label content if provided.
src/BootstrapBlazor/Components/Radio/RadioList.razor
src/BootstrapBlazor/Components/Radio/Radio.razor.cs
Added examples of ItemTemplate usage in the documentation
  • Added a new demo to CheckboxLists.razor showcasing the usage of ItemTemplate.
  • Added a new demo to Checkboxs.razor showcasing the usage of ChildContent.
  • Added a new demo to Radios.razor showcasing the usage of ItemTemplate.
  • Added IconSelectedItem class and IconDemoValues to CheckboxLists.razor.cs for the demo.
src/BootstrapBlazor.Server/Components/Samples/CheckboxLists.razor
src/BootstrapBlazor.Server/Components/Samples/Checkboxs.razor
src/BootstrapBlazor.Server/Components/Samples/Radios.razor
src/BootstrapBlazor.Server/Components/Samples/CheckboxLists.razor.cs
Added unit tests for ItemTemplate
  • Added a new unit test to verify the functionality of the ItemTemplate parameter in CheckboxList.
  • Added a new unit test to verify the functionality of the ChildContent parameter in Checkbox.
test/UnitTest/Components/CheckboxListTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5225 Add ItemTemplate functionality to CheckboxList component similar to RadioList and MultiSelect
#5225 Enable custom rendering of checkbox list items

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 27, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Jan 27, 2025
@ArgoZhang ArgoZhang changed the title feat(CheckboxList): add ItemTemplate parameter feat(CheckboxList): add ItemTemplate parameter Jan 27, 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 and they look great!

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.

@ArgoZhang ArgoZhang merged commit 3e217f1 into main Jan 27, 2025
4 checks passed
@ArgoZhang ArgoZhang deleted the feat-checkbox-list branch January 27, 2025 16:01
@codecov
Copy link

codecov bot commented Jan 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (175dac6) to head (21436e6).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5226   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          635       635           
  Lines        28243     28248    +5     
  Branches      4066      4068    +2     
=========================================
+ Hits         28243     28248    +5     

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

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(CheckboxList): add ItemTemplate parameter

2 participants