Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jun 6, 2025

Link issues

fixes #6169

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

Introduce a new UseGoogleDocs parameter to the PdfViewer component and update the sample to include a toggle for this option.

New Features:

  • Add UseGoogleDocs boolean parameter to PdfViewer component
  • Expose a switch in the demo to toggle the UseGoogleDocs setting

@bb-auto bb-auto bot added the enhancement New feature or request label Jun 6, 2025
@bb-auto bb-auto bot added this to the 9.7.0 milestone Jun 6, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jun 6, 2025

Reviewer's Guide

Introduce a UseGoogleDocs toggle for the PdfViewer component by adding a boolean field, binding it to a switch in the sample, and extending the PdfViewer tag to accept the new parameter; also update localization entries for the switch label.

Sequence Diagram for Toggling UseGoogleDocs Option

sequenceDiagram
    actor User
    participant Switch
    participant PdfViewersPage as "PdfViewers.razor Page"
    participant PdfViewerComponent as "PdfViewer Component"

    User->>Switch: Toggles 'UseGoogleDocs' switch
    Switch->>PdfViewersPage: Updates _useGoogleDocs value via @bind-Value
    alt Re-render
        PdfViewersPage->>PdfViewerComponent: Passes new UseGoogleDocs=@_useGoogleDocs value
        PdfViewerComponent->>PdfViewerComponent: (Internally) Re-renders PDF with new setting
    end
Loading

Class Diagram for PdfViewer Component Changes

classDiagram
    class PdfViewers {
        -ToastService toastService
        -_useGoogleDocs: bool
        +OnLoaded(): Task
        +NotSupportCallback(): Task
    }
    class PdfViewer {
        +Url: string
        +Height: string
        +NotSupportCallback: EventCallback
        +OnLoaded: EventCallback
        +UseGoogleDocs: bool
    }
    PdfViewers ..> PdfViewer : uses and configures
Loading

File-Level Changes

Change Details Files
Expose UseGoogleDocs toggle in the sample UI
  • Inserted a <Switch> bound to _useGoogleDocs inside the sample layout
  • Wrapped the switch in an input group with a UseGoogleDocs label
src/BootstrapBlazor.Server/Components/Samples/PdfViewers.razor
Bind new parameter on the PdfViewer component
  • Added UseGoogleDocs="@_useGoogleDocs" attribute to the <PdfViewer> tag
src/BootstrapBlazor.Server/Components/Samples/PdfViewers.razor
Initialize the toggle state in code-behind
  • Declared and initialized private bool _useGoogleDocs = true;
src/BootstrapBlazor.Server/Components/Samples/PdfViewers.razor.cs
Add localization entries for the switch label
  • Introduced UseGoogleDocs key in both English and Chinese locale files
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json

Assessment against linked issues

Issue Objective Addressed Explanation
#6169 Add a UseGoogleDocs 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

@ArgoZhang ArgoZhang merged commit c507f68 into main Jun 6, 2025
3 checks passed
@ArgoZhang ArgoZhang deleted the doc-pdf branch June 6, 2025 06:59
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: 3 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.

<PackageTips Name="BootstrapBlazor.PdfViewer" />

<DemoBlock Title="@Localizer["PdfViewerNormalTitle"]" Introduction="@Localizer["PdfViewerNormalIntro"]" Name="Normal">
<section ignore>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: Using a non-standard ignore attribute may not behave as expected

Consider replacing the non-standard ignore attribute with an @if block, a CSS class like d-none, or a framework-supported directive to control visibility.

Suggested implementation:

    <section class="d-none">
        <div class="row g-3">
            <div class="col-12 col-sm-6">

If you want to control the visibility dynamically, you can use an @if block or bind the class to a variable. For example:

@if (showSection)
{
    <section>
        ...
    </section>
}

or

<section class="@(showSection ? "" : "d-none")">
    ...
</section>

Replace showSection with your actual condition.

<div class="row g-3">
<div class="col-12 col-sm-6">
<BootstrapInputGroup>
<BootstrapInputGroupLabel DisplayText="UseGoogleDocs"></BootstrapInputGroupLabel>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: Label text should be localized

Use the Localizer for the label text to support localization, e.g., DisplayText="@localizer["UseGoogleDocs"]".

Suggested change
<BootstrapInputGroupLabel DisplayText="UseGoogleDocs"></BootstrapInputGroupLabel>
<BootstrapInputGroupLabel DisplayText="@Localizer["UseGoogleDocs"]"></BootstrapInputGroupLabel>


private bool _useGoogleDocs = true;

private Task OnLoaded() => ToastService.Success("Pdf Viewer", Localizer["PdfViewerToastSuccessfulContent"]);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue: Toast title is hard-coded and inconsistent

The success and error toasts use different titles ('Pdf Viewer' vs. 'PdfViewer'). Please standardize and consider localizing the title for consistency.

@codecov
Copy link

codecov bot commented Jun 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (16b02fe) to head (598c8e3).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6170   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          704       704           
  Lines        31099     31099           
  Branches      4394      4394           
=========================================
  Hits         31099     31099           
Flag Coverage Δ
BB 100.00% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

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 UseGoogleDocs parameter

2 participants