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(SelectTable): add IsClearable parameter #5074

Merged
merged 6 commits into from
Jan 9, 2025
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Jan 9, 2025

add IsClearable parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #5069

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 SelectTable component.

Copy link

sourcery-ai bot commented Jan 9, 2025

Reviewer's Guide by Sourcery

This PR adds an IsClearable parameter to the SelectTable component, allowing the user to clear the selected value.

Sequence diagram for clearing SelectTable value

sequenceDiagram
    actor User
    participant ST as SelectTable
    participant CA as OnClearAsync
    User->>ST: Click clear icon
    activate ST
    ST->>ST: OnClearValue()
    alt OnClearAsync is set
        ST->>CA: Execute OnClearAsync
    end
    ST->>ST: OnClickRowCallback(default)
    ST-->>User: Value cleared
    deactivate ST
Loading

Class diagram for SelectTable component changes

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

File-Level Changes

Change Details Files
Added IsClearable parameter
  • Added the IsClearable parameter to the SelectTable component.
  • Added the OnClearAsync event callback to the SelectTable component.
  • Added logic to handle the clear event and update the selected value accordingly.
src/BootstrapBlazor/Components/Select/SelectTable.razor.cs
Updated UI to include clear icon
  • Added a clear icon to the SelectTable component UI.
  • Added CSS styles for the clear icon.
  • Added logic to show/hide the clear icon based on the IsClearable parameter value.
src/BootstrapBlazor/Components/Select/SelectTable.razor
src/BootstrapBlazor/Components/Select/Select.razor.scss
Added unit tests
  • Added unit tests to verify the functionality of the IsClearable parameter.
  • Added tests to check the visibility and behavior of the clear icon.
  • Added tests to verify the OnClearAsync event callback is invoked correctly.
test/UnitTest/Components/SelectTableTest.cs
Updated documentation and examples
  • Updated the documentation to include information about the IsClearable parameter.
  • Added an example of how to use the IsClearable parameter.
  • Updated the localization files with the new text for the IsClearable parameter.
src/BootstrapBlazor.Server/Components/Samples/SelectTables.razor
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
Updated project file
  • Updated the project file to include the changes for the IsClearable parameter.
src/BootstrapBlazor/BootstrapBlazor.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#5069 Add IsClearable attribute to SelectTable component similar to Select 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 Jan 9, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 9, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jan 9, 2025
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 and they look great!

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

test/UnitTest/Components/SelectTableTest.cs Outdated Show resolved Hide resolved
test/UnitTest/Components/SelectTableTest.cs Show resolved Hide resolved
Copy link

codecov bot commented Jan 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (68ddec2) to head (faf2c5b).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5074   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          631       631           
  Lines        27969     27990   +21     
  Branches      4010      4015    +5     
=========================================
+ Hits         27969     27990   +21     

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

@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 removing the empty changes to localization files (en-US.json and zh-CN.json) from the PR
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 6113b85 into main Jan 9, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-select-table branch January 9, 2025 05: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(SelectTable): add IsClearable attribute to this component just like Select component.
1 participant