Skip to content

feat(PdfViewer): add OnLoaded parameter#452

Merged
ArgoZhang merged 5 commits intomasterfrom
feat-viewer
Jun 6, 2025
Merged

feat(PdfViewer): add OnLoaded parameter#452
ArgoZhang merged 5 commits intomasterfrom
feat-viewer

Conversation

@ArgoZhang
Copy link
Copy Markdown
Member

@ArgoZhang ArgoZhang commented Jun 6, 2025

Link issues

fixes #451

Summary By Copilot

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

Add OnLoaded and NotSupportCallback parameters to PdfViewer component and wire JS interop to trigger these callbacks on document load and unsupported viewer scenarios

New Features:

  • Expose OnLoaded parameter to invoke a .NET callback when the PDF document has loaded
  • Expose NotSupportCallback parameter to invoke a .NET callback when the browser’s PDF viewer isn’t supported

@bb-auto bb-auto Bot added the enhancement New feature or request label Jun 6, 2025
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Jun 6, 2025

Reviewer's Guide

Adds two callback parameters to the PdfViewer component—OnLoaded for when a PDF finishes loading and NotSupportCallback when the viewer is unsupported—by extending the C# component with new parameters and JSInvokable methods, updating the interop initialization to pass callback identifiers, and enhancing the JavaScript module to invoke these callbacks at the appropriate times.

Sequence Diagram for OnLoaded Callback

sequenceDiagram
    title Sequence Diagram for OnLoaded Callback
    participant UserCode as Consuming Code
    participant PdfViewerCS as PdfViewer.razor.cs
    participant PdfViewerJS as PdfViewer.razor.js
    participant Browser as Browser/PDF Engine

    UserCode->>PdfViewerCS: Initialize PdfViewer with OnLoaded delegate
    PdfViewerCS->>PdfViewerJS: InvokeInitAsync(Id, Interop, {LoadedCallaback: "TriggerOnLoaded", ...})
    PdfViewerJS->>Browser: command: Load PDF (e.g., set iframe src)
    Browser-->>PdfViewerJS: event: PDF loaded (e.g., iframe onload)
    PdfViewerJS->>PdfViewerCS: invokeMethodAsync("TriggerOnLoaded")
    PdfViewerCS->>PdfViewerCS: Execute TriggerOnLoaded()
    alt OnLoaded delegate is provided
        PdfViewerCS->>UserCode: Execute OnLoaded() Task
    end
Loading

File-Level Changes

Change Details Files
Introduce OnLoaded and NotSupportCallback parameters with corresponding JSInvokable triggers
  • Added Func? OnLoaded and NotSupportCallback parameters
  • Extended InvokeInitAsync to pass callback names in options
  • Implemented TriggerOnLoaded and TriggerNotSupportCallback JSInvokable methods
PdfViewer.razor.cs
Extend JavaScript interop to handle and invoke the new callbacks
  • Changed init signature to receive invoke and options
  • Check navigator.pdfViewerEnabled and invoke NotSupportCallback if unsupported
  • In loadPdf, attach onload handler to invoke LoadedCallback when frame loads
PdfViewer.razor.js

Assessment against linked issues

Issue Objective Addressed Explanation
#451 Add an OnLoaded parameter to the PdfViewer 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. 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.2.0 milestone Jun 6, 2025
Copy link
Copy Markdown

@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:

  • The JSON field “LoadedCallaback” is misspelled and doesn’t match the JS usage of loadedCallaback; correct it to loadedCallback (and update both sides) so your interop callback actually fires.
  • Your JS checks for options.notSupportCallback (camelCase) but .NET is serializing NotSupportCallback (PascalCase); align the property names/casing between the C# JSON and JS to avoid undefined callbacks.
Here's what I looked at during the review
  • 🟡 General issues: 5 issues found
  • 🟢 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.

Comment thread src/components/BootstrapBlazor.PdfViewer/PdfViewer.razor.cs
Comment thread src/components/BootstrapBlazor.PdfViewer/PdfViewer.razor.cs
Comment thread src/components/BootstrapBlazor.PdfViewer/PdfViewer.razor.cs
Comment thread src/components/BootstrapBlazor.PdfViewer/PdfViewer.razor.js Outdated
Comment thread src/components/BootstrapBlazor.PdfViewer/PdfViewer.razor.js
@ArgoZhang
Copy link
Copy Markdown
Member Author

@sourcery-review

@ArgoZhang ArgoZhang merged commit c20963a into master Jun 6, 2025
1 check passed
@ArgoZhang ArgoZhang deleted the feat-viewer branch June 6, 2025 03:01
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(PdfViewer): add OnLoaded parameter

1 participant