Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Apr 25, 2025

Link issues

fixes #5888

Summary By Copilot

This pull request introduces enhancements and bug fixes for the PopConfirmButton component in the BootstrapBlazor library. Key updates include improvements to the JavaScript interop for managing callbacks, removal of default OnConfirm and OnClose assignments, and additional safety checks. Below is a detailed breakdown of the changes:

Component Behavior Enhancements:

  • PopConfirmButtonBase.cs: Removed default assignments for OnConfirm and OnClose to allow for null values and added a TriggerCloseCallback method to handle OnClose events via JavaScript interop. The InvokeInitAsync method was also updated to pass the OnClose callback to the JavaScript initialization function.

  • PopConfirmButton.razor.cs: Added null checks for OnConfirm before invoking it in the OnClickConfirm method to prevent potential runtime errors. [1] [2]

JavaScript Interop Improvements:

  • PopConfirmButton.razor.js: Enhanced the init function to accept invoke and closeCallback parameters for better callback handling. Updated the dispose function to clean up event listeners and added logic to invoke the closeCallback when hiding the popover. [1] [2] [3] [4]

Code Simplifications and Safety Updates:

  • PopConfirmButtonBase.cs: Removed [NotNull] attributes from OnConfirm and OnClose properties to align with the removal of default assignments and improve null-safety handling. [1] [2]

Version Update:

Related Updates in Other Components:

  • TableExtensionButton.razor.cs and TableToolbar.razor.cs: Added null checks for OnConfirm callbacks to ensure they are invoked only when defined. [1] [2]

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

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

Enhance PopConfirmButton component by improving JavaScript interop, adding null-safety for callbacks, and supporting OnClose event triggering

New Features:

  • Add support for triggering OnClose event callback when clicking outside the popover

Bug Fixes:

  • Add null checks to prevent potential runtime errors when invoking callbacks

Enhancements:

  • Improve null-safety for OnConfirm and OnClose callbacks
  • Enhance JavaScript interop for popover event handling

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

sourcery-ai bot commented Apr 25, 2025

Reviewer's Guide by Sourcery

This pull request enhances the PopConfirmButton component by adding support for the OnClose event when clicking outside the popover, improving null-safety, and updating the project version. The JavaScript interop was updated to handle the OnClose event, and null checks were added to prevent potential runtime errors. Additionally, similar null checks were added to TableExtensionButton and TableToolbar components.

Sequence diagram for PopConfirmButton OnClose event

sequenceDiagram
    participant User
    participant PopConfirmButton
    participant JavaScript

    User->PopConfirmButton: Click outside popover
    PopConfirmButton->JavaScript: EventListener (click outside)
    JavaScript->JavaScript: popover.hide()
    JavaScript->PopConfirmButton: invoke.invokeMethodAsync(closeCallback)
    PopConfirmButton->PopConfirmButton: TriggerCloseCallback()
    PopConfirmButton->PopConfirmButton: OnClose()
Loading

File-Level Changes

Change Details Files
Enhanced JavaScript interop for PopConfirmButton to handle OnClose events when clicking outside the popover.
  • Modified the init function in PopConfirmButton.razor.js to accept invoke and closeCallback parameters.
  • Added logic to invoke the closeCallback when hiding the popover in PopConfirmButton.razor.js.
  • Added a TriggerCloseCallback method to PopConfirmButtonBase.cs to handle OnClose events via JavaScript interop.
  • Updated the InvokeInitAsync method in PopConfirmButtonBase.cs to pass the OnClose callback to the JavaScript initialization function.
src/BootstrapBlazor/Components/Button/PopConfirmButton.razor.js
src/BootstrapBlazor/Components/Button/PopConfirmButtonBase.cs
Improved null-safety by removing default assignments for OnConfirm and OnClose events in PopConfirmButtonBase.cs and adding null checks before invoking OnConfirm in PopConfirmButton.razor.cs.
  • Removed default assignments for OnConfirm and OnClose in PopConfirmButtonBase.cs.
  • Removed [NotNull] attributes from OnConfirm and OnClose properties in PopConfirmButtonBase.cs.
  • Added null checks for OnConfirm before invoking it in the OnClickConfirm method in PopConfirmButton.razor.cs.
src/BootstrapBlazor/Components/Button/PopConfirmButtonBase.cs
src/BootstrapBlazor/Components/Button/PopConfirmButton.razor.cs
Added null checks for OnConfirm callbacks in TableExtensionButton.razor.cs and TableToolbar.razor.cs.
  • Added null checks for OnConfirm callbacks to ensure they are invoked only when defined in TableExtensionButton.razor.cs.
  • Added null checks for OnConfirm callbacks to ensure they are invoked only when defined in TableToolbar.razor.cs.
src/BootstrapBlazor/Components/Table/TableExtensionButton.razor.cs
src/BootstrapBlazor/Components/Table/TableToolbar.razor.cs
Updated the project version.
  • Updated the project version from 9.5.11-beta03 to 9.5.11-beta04.
src/BootstrapBlazor/BootstrapBlazor.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#5888 Support triggering an OnClose event callback when the PopConfirmButton is closed by clicking outside the button (e.g., on the document).

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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

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.5.0 milestone Apr 25, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Apr 25, 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 - here's some feedback:

Overall Comments:

  • Consider adding a try-catch block around the OnConfirm and OnClose callbacks to prevent exceptions from breaking the component.
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.

@codecov
Copy link

codecov bot commented Apr 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (5687352) to head (47c9298).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5889   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          661       661           
  Lines        30412     30430   +18     
  Branches      4319      4323    +4     
=========================================
+ Hits         30412     30430   +18     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ArgoZhang ArgoZhang merged commit 9f0d084 into main Apr 25, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-pop branch April 25, 2025 04:49
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(PopConfirmButton): support trigger OnClose event callback when click document

3 participants