Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Dec 27, 2024

add Component parameter on DrawerOption

Summary of the changes (Less than 80 chars)

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

Description

fixes #4961

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:

  • Allow developers to use custom components in DrawerOption by introducing the Component parameter.

ArgoZhang and others added 3 commits December 27, 2024 13:36
Co-Authored-By: MadLongTom <[email protected]>
Co-Authored-By: Frost Autumn <[email protected]>
Co-Authored-By: ice6 <[email protected]>
Co-Authored-By: Alex chow <[email protected]>
@bb-auto bb-auto bot added the enhancement New feature or request label Dec 27, 2024
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Dec 27, 2024

Reviewer's Guide by Sourcery

This pull request introduces a new Component parameter to the DrawerOption class, allowing developers to pass a BootstrapDynamicComponent as an argument. This enhancement provides greater flexibility in customizing the content displayed within the Drawer component.

Sequence diagram for Drawer content rendering

sequenceDiagram
    participant DC as DrawerContainer
    participant DO as DrawerOption
    participant DE as DrawerOptionExtensions

    DC->>DO: GetParameters()
    DO->>DE: GetContent()
    alt ChildContent exists
        DE-->>DC: Return ChildContent
    else Component exists
        DE-->>DC: Return Component.Render()
    else Neither exists
        DE-->>DC: Return null
    end
    Note over DC: Add content to parameters
Loading

File-Level Changes

Change Details Files
Added Component parameter to DrawerOption
  • Introduced a new property named Component of type BootstrapDynamicComponent to the DrawerOption class. This property allows developers to specify a dynamic component to be rendered within the drawer.
src/BootstrapBlazor/Components/Drawer/DrawerOption.cs
Updated DrawerContainer to render the provided component
  • Modified the GetParameters method in DrawerContainer to check for the presence of a Component in the provided DrawerOption. If a component is specified, it is rendered instead of the ChildContent.
src/BootstrapBlazor/Components/Drawer/DrawerContainer.cs
Added extension method GetContent to DrawerOption
  • Created a new extension method GetContent for the DrawerOption class. This method returns the content to be rendered within the drawer, prioritizing the Component property over the ChildContent property.
src/BootstrapBlazor/Extensions/DrawerOptionExtensions.cs
Updated unit tests for DrawerService
  • Added new test cases to verify the functionality of the Component parameter in DrawerOption. These tests cover scenarios where both Component and ChildContent are provided, as well as cases where only one or neither is specified.
test/UnitTest/Services/DrawerServiceTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4961 Add a Component attribute to Drawer similar to dialog's implementation for consistent API design

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 this to the v9.0.0 milestone Dec 27, 2024
@ArgoZhang ArgoZhang enabled auto-merge (squash) December 27, 2024 05:45
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 adding English documentation for the new Component parameter to improve accessibility for non-Chinese speaking developers.
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 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4964   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          629       630    +1     
  Lines        28096     28099    +3     
  Branches      4035      4036    +1     
=========================================
+ Hits         28096     28099    +3     

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

@ArgoZhang ArgoZhang merged commit 9d8fddb into main Dec 27, 2024
4 checks passed
@ArgoZhang ArgoZhang deleted the feat-drawer branch December 27, 2024 05:50
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(Drawer): add Component attribute just like dialog does.

2 participants