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(Checkbox): use client click instead of server event #4620

Merged
merged 13 commits into from
Nov 7, 2024

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Nov 7, 2024

use client click instead of server event

Summary of the changes (Less than 80 chars)

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

Description

fixes #4619

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

Switch checkbox click handling from server-side to client-side to improve performance and responsiveness. Add support for stopping event propagation in checkboxes and update tests to cover these changes.

New Features:

  • Introduce client-side click handling for checkboxes, replacing server-side event handling.

Enhancements:

  • Add support for stopping event propagation in checkboxes.

Tests:

  • Add tests for the new client-side click handling and event propagation stopping features in checkboxes.

Copy link

sourcery-ai bot commented Nov 7, 2024

Reviewer's Guide by Sourcery

This PR refactors the Checkbox component to use client-side click handling instead of server events. The implementation moves the click event handling to JavaScript, improves state management, and updates all related test cases to use the new API.

Sequence diagram for client-side click handling in Checkbox

sequenceDiagram
    actor User
    participant Checkbox
    participant JavaScript
    participant Server

    User->>Checkbox: Click
    Checkbox->>JavaScript: TriggerClick
    JavaScript->>Checkbox: SyncStateCallback
    Checkbox-->>User: Update UI
    Note over Checkbox,JavaScript: No server interaction needed
Loading

Updated class diagram for Checkbox component

classDiagram
    class Checkbox {
        +bool StopPropagation
        +string? StopPropagationString
        +CheckboxState NextState
        +ValueTask TriggerOnBeforeStateChanged()
        +ValueTask SyncStateCallback(CheckboxState state)
        +ValueTask TriggerClick()
    }
    class ValidateBase {
    }
    Checkbox --|> ValidateBase
    note for Checkbox "Refactored to handle clicks client-side"
Loading

File-Level Changes

Change Details Files
Refactored Checkbox component to handle clicks on the client side
  • Added client-side state management in JavaScript
  • Removed server-side click handler (OnToggleClick)
  • Added new TriggerClick and SyncStateCallback methods for JS interop
  • Implemented state synchronization between client and server
  • Added StopPropagationString property for click event handling
src/BootstrapBlazor/Components/Checkbox/Checkbox.razor
src/BootstrapBlazor/Components/Checkbox/Checkbox.razor.cs
src/BootstrapBlazor/Components/Checkbox/Checkbox.razor.js
Updated test cases to use new Checkbox API
  • Replaced direct input.Click() calls with Checkbox.TriggerClick()
  • Updated checkbox selection tests to use FindComponents<Checkbox>()
  • Added new tests for StopPropagation and SyncStateCallback
  • Updated async/await patterns in test methods
test/UnitTest/Components/TableTest.cs
test/UnitTest/Components/CheckboxListTest.cs
test/UnitTest/Components/TableDialogTest.cs
test/UnitTest/Components/TableDrawerTest.cs
test/UnitTest/Components/TreeViewTest.cs
test/UnitTest/Components/ConsoleTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4619 Replace server-side event handling with client-side click handling for checkboxes

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 7, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Nov 7, 2024
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Nov 7, 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:

  • The PR removes the StopPropagation parameter and hardcodes e.stopPropagation() in the JS code. Consider keeping this configurable to support cases where event bubbling is needed.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (cc22758) to head (3de074b).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4620   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          620       620           
  Lines        27379     27381    +2     
  Branches      3917      3914    -3     
=========================================
+ Hits         27379     27381    +2     

☔ 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 and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 2 issues 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 ArgoZhang merged commit 9fcd84c into main Nov 7, 2024
4 checks passed
@ArgoZhang ArgoZhang deleted the refactor-checkbox branch November 7, 2024 11: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(Checkbox): use client click instead of server event
1 participant