Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 5, 2025

support trigger OnCloseAsync when set IsAutoHide to true

Summary of the changes (Less than 80 chars)

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

Description

fixes #5035

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

Allow SweetAlert to trigger OnCloseAsync callback when IsAutoHide is set to true.

New Features:

  • Added support for triggering the OnCloseAsync callback when the SweetAlert is configured to auto-hide.

Tests:

  • Added a test case to verify the new functionality.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 5, 2025

Reviewer's Guide by Sourcery

This PR allows SweetAlert to trigger the OnCloseAsync callback when IsAutoHide is set to true, addressing issue #5035. This change ensures that asynchronous close callbacks are supported when auto-hiding is enabled.

Sequence diagram for SweetAlert auto-hide with OnCloseAsync

sequenceDiagram
    participant Component
    participant SweetAlert
    participant ModalContainer

    Component->>SweetAlert: Show(SwalOption)
    Note over SweetAlert: Check IsAutoHide & Delay
    SweetAlert->>SweetAlert: Set OnCloseCallbackAsync
    SweetAlert->>ModalContainer: Show Dialog
    Note over SweetAlert: Wait for Delay
    SweetAlert->>ModalContainer: Close
    SweetAlert->>SweetAlert: Execute OnCloseCallbackAsync
Loading

Class diagram for SweetAlert component changes

classDiagram
    class SweetAlert {
        -bool IsShowDialog
        -CancellationTokenSource DelayToken
        -Func~Task~ OnCloseCallbackAsync
        +Task OnAfterRenderAsync(bool firstRender)
        -bool AutoHideCheck()
        -Task Show(SwalOption option)
    }

    class SwalOption {
        +string Title
        +string Content
        +Func~Task~ OnCloseAsync
        +Func~Task~ OnConfirmAsync
    }

    SweetAlert ..> SwalOption
    note for SweetAlert "Added OnCloseCallbackAsync to handle auto-hide close events"
Loading

State diagram for SweetAlert auto-hide behavior

stateDiagram-v2
    [*] --> Closed
    Closed --> Showing: Show(SwalOption)
    Showing --> AutoHiding: IsAutoHide & Delay > 0
    Showing --> Displayed: !IsAutoHide
    AutoHiding --> Closed: After Delay
    Displayed --> Closed: Manual Close

    note right of AutoHiding: Now triggers OnCloseAsync
Loading

File-Level Changes

Change Details Files
Added support for OnCloseAsync callback when IsAutoHide is true
  • Added OnCloseCallbackAsync field to SweetAlert component.
  • Added logic to invoke OnCloseAsync callback after the delay when IsAutoHide is true and Delay is set.
  • Disposed the DelayToken after cancellation and created a new one to prevent issues with subsequent calls.
  • Set OnCloseCallbackAsync to the provided OnCloseAsync callback if IsAutoHide is true and Delay is greater than 0, otherwise set it to null.
src/BootstrapBlazor/Components/SweetAlert/SweetAlert.razor.cs
Updated SweetAlert usage in unit tests
  • Added OnCloseAsync callback to the SwalOption object in the Show_Ok test case to verify the functionality.
test/UnitTest/Components/SwalTest.cs
Removed unnecessary conditional compilation in SweetContext
  • Removed the conditional compilation for the ConfirmTask property, making it always initialized.
src/BootstrapBlazor/Components/SweetAlert/SweetContext.cs
Added documentation for SwalOption constructor
  • Added a comment to the SwalOption constructor.
src/BootstrapBlazor/Components/SweetAlert/SwalOption.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5035 Add a callback mechanism for SweetAlert when IsAutoHide is set to true
#5035 Enable triggering OnCloseAsync when auto-hide is active

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 5, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 5, 2025
@ArgoZhang ArgoZhang enabled auto-merge (squash) January 5, 2025 03:08
@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: 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 Jan 5, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (8407fc6) to head (7cdd831).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5040   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          631       631           
  Lines        27957     27964    +7     
  Branches      4006      4008    +2     
=========================================
+ Hits         27957     27964    +7     

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

@ArgoZhang ArgoZhang merged commit 89283d2 into main Jan 5, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-swal branch January 5, 2025 03:10
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(sweet-alert): add callback for IsAutoHide

2 participants