feat(IFrame): add OnReadyAsync callback

[ArgoZhang]

add OnReadyAsync callback

Summary of the changes (Less than 80 chars)

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

Description

fixes #5349

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

Add an OnReadyAsync callback to the IFrame component, which is triggered when the IFrame has finished loading.

New Features:

• Added an OnReadyAsync parameter to the IFrame component to provide a callback that is invoked when the iframe content has fully loaded.

Tests:

• Added unit tests for the new OnReadyAsync callback.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR adds an OnReadyAsync callback to the IFrame component that gets executed when the iframe has fully loaded. The implementation involves adding a new parameter, updating the JS interop to trigger the callback on the frame's onload event, and revising tests to validate the new functionality.

Sequence diagram for IFrame OnReadyAsync callback

sequenceDiagram
    participant JS as JavaScript
    participant IFrame as IFrame Component
    participant Callback as OnReadyAsync Callback

    Note over JS: Frame onload event occurs
    JS->>IFrame: invokeMethodAsync("TriggerLoaded")
    IFrame->>IFrame: TriggerLoaded()
    IFrame->>Callback: await OnReadyAsync()
    Callback-->>IFrame: (callback executed)

Loading

File-Level Changes

Change	Details	Files
Added OnReadyAsync parameter and new JSInvokable method for handling iframe loaded callback	Introduced a new parameter OnReadyAsync in the IFrame component Implemented a new JSInvokable method TriggerLoaded that invokes OnReadyAsync when called Updated summary comments for clarity in the component code	src/BootstrapBlazor/Components/IFrame/IFrame.razor.cs
Modified JavaScript interop to support the new OnReadyAsync callback	Updated the init function to continue listening for messages with the existing handler Changed the frame's onload event handler to call the TriggerLoaded method via JS interop Refactored the execute function to ensure proper postMessage handling	src/BootstrapBlazor/Components/IFrame/IFrame.razor.js
Updated unit tests to validate the new loaded callback functionality	Changed test method to async Task to support asynchronous callbacks Replaced calls to the old CallbackAsync with TriggerPostData Set up and validated the OnReadyAsync callback execution by asserting a flag when TriggerLoaded is invoked	test/UnitTest/Components/IFrameTest.cs
Merged project file changes from the main branch	Synced project file to include latest changes from the main branch	src/BootstrapBlazor/BootstrapBlazor.csproj

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#5349	Add an OnReadyAsync callback to the IFrame component	✅

Possibly linked issues

• feat(IFrame): add OnReadyAsync callback #5349: The PR adds the OnReadyAsync callback requested by the issue.

---

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!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider renaming TriggerPostData and TriggerLoaded to OnPostData and OnReady to align with .NET naming conventions for event callbacks.
• The javascript execute function does not check if the frame is loaded before calling postMessage.

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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files

@@            Coverage Diff            @@
##              main     #5350   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          644       644           
  Lines        29199     29206    +7     
  Branches      4123      4124    +1     
=========================================
+ Hits         29199     29206    +7     

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

[ArgoZhang]

@sourcery-ai review

[sourcery-ai]

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider consolidating the JavaScript functions into a single module for better organization.
• The JavaScript execute function should check if the frame is loaded before posting the message.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}