Skip to content

feat(PdfViewer): add embedded parameter#464

Merged
ArgoZhang merged 3 commits intomasterfrom
feat-url
Jun 8, 2025
Merged

feat(PdfViewer): add embedded parameter#464
ArgoZhang merged 3 commits intomasterfrom
feat-url

Conversation

@ArgoZhang
Copy link
Copy Markdown
Member

@ArgoZhang ArgoZhang commented Jun 8, 2025

Link issues

fixes #463

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 embedded support to the PDF viewer's Google Docs mode by appending the embedded flag to the viewer URL and ensuring URLs are fully qualified before loading.

New Features:

  • Add 'embedded=true' parameter to Google Docs viewer URL for embedded PDF rendering

Bug Fixes:

  • Fix issue where relative PDF URLs failed to load when using Google Docs integration

Enhancements:

  • Inject NavigationManager and introduce GetAbsoluteUri to convert PDF URLs to absolute when UseGoogleDocs is enabled

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

sourcery-ai Bot commented Jun 8, 2025

Reviewer's Guide

Enhance PdfViewer to support embedded Google Docs rendering by injecting NavigationManager, converting PDF URLs to absolute URIs, and updating the JS loader to include the embedded parameter.

Sequence Diagram: PDF Loading with Google Docs (Embedded Mode)

sequenceDiagram
    participant Comp as "PdfViewer Component (C#)"
    participant NavMan as "NavigationManager"
    participant JS as "PdfViewer.js (loadPdf)"
    participant GDocs as "Google Docs Viewer (iframe)"

    Comp->>NavMan: ToAbsoluteUri(pdfUrl)
    NavMan-->>Comp: absolutePdfUrl
    Comp->>JS: Invoke loadPdf(absolutePdfUrl)
    JS->>JS: newUrl = `https://docs.google.com/viewer?url=${absolutePdfUrl}&embedded=true`
    JS->>GDocs: Set iframe.src = newUrl
Loading

Class Diagram: PdfViewer Component Updates

classDiagram
  class PdfViewer {
    +bool UseGoogleDocs
    -NavigationManager? NavigationManager
    -string GetAbsoluteUri(string? url)
    #Task OnAfterRenderAsync(bool firstRender)
    #Task OnParametersSetAsync()
  }
  PdfViewer ..> NavigationManager : "uses (dependency)"
Loading

File-Level Changes

Change Details Files
Inject NavigationManager and adjust UseGoogleDocs setup
  • Removed default value assignment for UseGoogleDocs
  • Added [Inject, NotNull] NavigationManager dependency
src/components/BootstrapBlazor.PdfViewer/PdfViewer.razor.cs
Convert PDF URLs to absolute URIs when Google Docs mode is enabled
  • Replaced raw URL usages with GetAbsoluteUri in InvokeVoidAsync calls
  • Added GetAbsoluteUri helper to conditionally build absolute URIs
src/components/BootstrapBlazor.PdfViewer/PdfViewer.razor.cs
Enable embedded=true flag in Google Docs viewer URL
  • Updated loadPdf JS function to append &embedded=true to the Google Docs URL
src/components/BootstrapBlazor.PdfViewer/PdfViewer.razor.js

Assessment against linked issues

Issue Objective Addressed Explanation
#463 Add an 'embedded' parameter to the PDF viewer component when using Google Docs for rendering.

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 8, 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 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: 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.js
@ArgoZhang ArgoZhang merged commit 71806c3 into master Jun 8, 2025
1 check passed
@ArgoZhang ArgoZhang deleted the feat-url branch June 8, 2025 07:44
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 embedded parameter

1 participant