Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 10, 2025

add IsClearable parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #5081

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:

  • Added an IsClearable parameter to the Cascader component.

@bb-auto bb-auto bot added the enhancement New feature or request label Jan 10, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 10, 2025

Reviewer's Guide by Sourcery

This PR adds an IsClearable parameter to the Cascader component, allowing users to clear the selected value.

Sequence diagram for clearing Cascader value

sequenceDiagram
    actor User
    participant C as Cascader
    User->>C: Click clear icon
    activate C
    C->>C: OnClearValue()
    alt OnClearAsync is set
        C->>C: OnClearAsync()
    end
    C->>C: CurrentValue = default
    deactivate C
Loading

Class diagram for Cascader component changes

classDiagram
    class Cascader {
        +bool IsClearable
        +string ClearIcon
        +Func~Task~ OnClearAsync
        -string ClearClassString
        -bool GetClearable()
        -Task OnClearValue()
    }
    note for Cascader "Added clearable functionality"
Loading

File-Level Changes

Change Details Files
Added IsClearable parameter to the Cascader component
  • Added IsClearable parameter to the Cascader component.
  • Added ClearIcon parameter to customize the clear icon.
  • Added OnClearAsync callback to handle clear events.
  • Added unit tests for the IsClearable parameter.
  • Updated the Cascaders.razor sample to demonstrate the IsClearable parameter.
  • Updated styles for the clear button in Select.razor.scss.
  • Updated SelectObject.razor.cs to handle clear events correctly.
src/BootstrapBlazor/Components/Cascader/Cascader.razor
src/BootstrapBlazor/Components/Cascader/Cascader.razor.cs
test/UnitTest/Components/CascaderTest.cs
src/BootstrapBlazor.Server/Components/Samples/Cascaders.razor
src/BootstrapBlazor/Components/Select/Select.razor.scss
src/BootstrapBlazor/Components/Select/SelectObject.razor.cs
Updated documentation and localization files
  • Updated documentation to describe the IsClearable parameter.
  • Updated localization files for the IsClearable parameter.
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
Updated project file
  • Updated project file to include changes related to the IsClearable parameter.
src/BootstrapBlazor/BootstrapBlazor.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#5081 Add an IsClearable parameter to the Cascader component to improve user experience
#5081 Ensure consistent functionality across selectable and inputable controls

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 this to the v9.2.0 milestone Jan 10, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jan 10, 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: 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.

@ArgoZhang
Copy link
Member Author

@sourcery-ai review

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.

@codecov
Copy link

codecov bot commented Jan 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5084   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          631       631           
  Lines        28013     28034   +21     
  Branches      4020      4025    +5     
=========================================
+ Hits         28013     28034   +21     

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

@ArgoZhang ArgoZhang merged commit 575f399 into main Jan 10, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-cascader branch January 10, 2025 05:26
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(Cascader): add IsClearable parameter

2 participants