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(Collapse): add HeaderTemplate parameter #4763

Merged
merged 12 commits into from
Nov 30, 2024
Merged

feat(Collapse): add HeaderTemplate parameter #4763

merged 12 commits into from
Nov 30, 2024

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Nov 30, 2024

add HeaderTemplate parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #4754

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 a HeaderTemplate parameter to the Collapse component to enable header customization, refactor CSS for improved styling, and update tests to cover the new feature.

New Features:

  • Introduce a HeaderTemplate parameter to the Collapse component, allowing customization of the header display content.

Enhancements:

  • Refactor the Collapse component's CSS to improve styling and layout, including changes to the accordion header and button classes.

Tests:

  • Add a new test case to verify the functionality of the HeaderTemplate parameter in the Collapse component.

Copy link

sourcery-ai bot commented Nov 30, 2024

Reviewer's Guide by Sourcery

This PR adds a new HeaderTemplate parameter to the Collapse component, allowing for customized header content. The implementation includes UI styling updates, new localization entries, and refactoring of the header rendering logic to support the template feature.

Class diagram for the updated Collapse component

classDiagram
    class Collapse {
        static string? GetHeaderButtonClassString(CollapseItem item)
        static string? GetItemIconString(CollapseItem item)
        static string? GetHeaderClassString(CollapseItem item)
        static string? GetClassString(bool collapsed)
    }
    note for Collapse "Refactored to support HeaderTemplate and updated styling methods"
Loading

File-Level Changes

Change Details Files
Added HeaderTemplate parameter and related properties to CollapseItem component
  • Added HeaderTemplate parameter to allow custom header content
  • Added HeaderClass parameter for custom header styling
  • Updated component documentation and parameter descriptions
  • Fixed typo in Collapse property name
src/BootstrapBlazor/Components/Collapse/CollapseItem.cs
Refactored Collapse component's header rendering logic
  • Replaced Button component with custom header structure
  • Added conditional rendering for HeaderTemplate content
  • Implemented new CSS classes for header styling
  • Added icon rendering support in header
src/BootstrapBlazor/Components/Collapse/Collapse.razor
Updated SCSS styling for accordion headers
  • Restructured accordion header layout using flexbox
  • Added new styling for header states (collapsed/expanded)
  • Updated border radius handling for first and last items
  • Removed redundant button color styles
src/BootstrapBlazor/Components/Collapse/Collapse.razor.scss
Added demo and documentation for HeaderTemplate feature
  • Added new demo section for HeaderTemplate usage
  • Added attribute documentation for new parameters
  • Updated localization entries for both English and Chinese
  • Added example with Select component in header
src/BootstrapBlazor.Shared/Components/Samples/Collapses.razor
src/BootstrapBlazor.Shared/Components/Samples/Collapses.razor.cs
src/BootstrapBlazor.Shared/Locales/en-US.json
src/BootstrapBlazor.Shared/Locales/zh-CN.json

Assessment against linked issues

Issue Objective Addressed Explanation
#4754 Add HeaderTemplate parameter to Collapse component to allow customization of header content

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 Nov 30, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Nov 30, 2024
@ArgoZhang
Copy link
Collaborator Author

@sourcery-ai review

sourcery-ai[bot]
sourcery-ai bot previously approved these changes Nov 30, 2024
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 - here's some feedback:

Overall Comments:

  • Consider maintaining consistent documentation language (either English or Chinese) throughout the codebase for better maintainability.
  • Unrelated changes (like removing #if NET9_0_OR_GREATER) should be moved to a separate pull request to maintain clear change history.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟢 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
Copy link
Collaborator Author

@sourcery-ai review

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 - here's some feedback:

Overall Comments:

  • Consider adding more detailed documentation for the HeaderTemplate parameter, including usage examples and limitations. This will help other developers understand how to properly implement custom headers.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟢 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 Nov 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (abfd210) to head (91e7b3d).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4763   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          620       620           
  Lines        27407     27424   +17     
  Branches      3923      3925    +2     
=========================================
+ Hits         27407     27424   +17     

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

@ArgoZhang ArgoZhang merged commit f37d81e into main Nov 30, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-collapse branch November 30, 2024 02:44
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(Collapse): Collapse title header template - RenderFragment
1 participant