Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jun 6, 2025

Link issues

fixes #6163

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 PdfViewer component for rendering PDF documents, including a demo page in the application menu, localization, and documentation updates.

New Features:

  • Add PdfViewer component with support for stream mode, zoom, page modes, watermark, search, and navigation
  • Provide a dedicated sample page (/pdf-viewer) showcasing PdfViewer usage with interactive configuration

Enhancements:

  • Register the PdfViewer demo in the application menu under "PdfViewer"
  • Add localization entries for PdfViewer labels and descriptions in English and Chinese

Documentation:

  • Update docs.json to include PdfViewer documentation and sample
  • Add localized descriptions for PdfViewer in en-US and zh-CN locale files

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

sourcery-ai bot commented Jun 6, 2025

Reviewer's Guide

Introduces a new PdfViewer component by registering it in the application menu, updating server project references, extending localization and documentation entries, and providing a sample page with full code-behind implementation.

File-Level Changes

Change Details Files
Registered new PdfViewer route in application menu
  • Inserted a new DemoMenuItem with IsNew flag
  • Set Text to localized "PdfViewer"
  • Mapped Url to "/pdf-viewer"
src/BootstrapBlazor.Server/Extensions/MenusLocalizerExtensions.cs
Added PdfViewer package reference in server project
  • Referenced BootstrapBlazor.PdfViewer NuGet package
  • Updated package version
src/BootstrapBlazor.Server/BootstrapBlazor.Server.csproj
Extended localization and documentation for PdfViewer
  • Added title, description, and demo labels in en-US.json and zh-CN.json
  • Updated docs.json with PdfViewer metadata
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
src/BootstrapBlazor.Server/docs.json
Implemented PdfViewer sample page and code-behind
  • Created PdfViewers.razor with DemoBlock markup for PdfViewer
  • Implemented PdfViewers.razor.cs with component state and control methods
  • Defined attribute metadata list for PdfReader
src/BootstrapBlazor.Server/Components/Samples/PdfViewers.razor
src/BootstrapBlazor.Server/Components/Samples/PdfViewers.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#6163 Implement a PdfViewer component.
#6163 Add a demo page for the PdfViewer component.
#6163 Add the PdfViewer component to the menu.

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 9.7.0 milestone Jun 6, 2025
@ArgoZhang ArgoZhang merged commit 3011026 into main Jun 6, 2025
4 checks passed
@ArgoZhang ArgoZhang deleted the refactor-pdf branch June 6, 2025 00:19
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 - here's some feedback:

  • Rename PdfViewers.razor (and its code‐behind class) to singular PdfViewer to align file names, route ("/pdf-viewer"), component name, and localization keys.
  • Add bounds checks in ApplyPagePrevious/ApplyPageNext to ensure Page never falls below 1 (or exceeds total pages) before calling Refresh.
  • Extract the repetitive switch logic in ApplyZoom and ApplyPageMode into reusable helper methods or data-driven mappings to reduce boilerplate.
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.

@codecov
Copy link

codecov bot commented Jun 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.99%. Comparing base (406eb19) to head (ac2fe9a).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6164   +/-   ##
=======================================
  Coverage   99.99%   99.99%           
=======================================
  Files         704      704           
  Lines       31099    31099           
  Branches     4395     4395           
=======================================
  Hits        31098    31098           
  Partials        1        1           

☔ 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 PdfViewer component

2 participants