Skip to content

feat(PdfReader): add IsShow parameter#7357

Merged
ArgoZhang merged 7 commits intomainfrom
feat-pdf
Dec 18, 2025
Merged

feat(PdfReader): add IsShow parameter#7357
ArgoZhang merged 7 commits intomainfrom
feat-pdf

Conversation

@ArgoZhang
Copy link
Copy Markdown
Member

@ArgoZhang ArgoZhang commented Dec 17, 2025

Link issues

fixes #7355
fixes #7358

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

Documentation:

  • Add descriptive text and list items to the PdfReader demo explaining FontAwesome usage, PDF stream configuration, and download file name option.

Copilot AI review requested due to automatic review settings December 17, 2025 11:58
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Dec 17, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds documentation and localization strings for the new PdfReader DownloadFileName parameter and explains required FontAwesome stylesheet setup in the sample page.

File-Level Changes

Change Details Files
Enhance PdfReader sample documentation to describe new features and dependencies.
  • Add localized description paragraph for using FontAwesome icons with PdfReader.
  • Show the required link tag for including the BootstrapBlazor FontAwesome CSS asset in the sample.
  • List and explain setting a PDF stream and the new DownloadFileName parameter in the demo introduction section.
src/BootstrapBlazor.Server/Components/Samples/PdfReaders.razor
Wire up localization resources for the new PdfReader descriptions.
  • Add English resource strings for FontAwesome usage, PDF stream configuration, and DownloadFileName parameter documentation.
  • Add Chinese resource strings mirroring the new English entries for the PdfReader demo.
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
Adjust server project configuration if needed for new assets or sample changes.
  • Update project references or static asset configuration related to BootstrapBlazor.FontAwesome or PdfReader samples, if applicable.
src/BootstrapBlazor.Server/BootstrapBlazor.Server.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#7355 Ensure PdfReader reliably renders and displays page content after its content is set, including in scenarios involving StateHasChanged, overlays (z-index), and modals, potentially by adding a refresh mechanism or similar fix. The PR only updates the PdfReaders sample component and localization text (e.g., adding description items and FontAwesome CSS usage). There are no changes to PdfReader logic, rendering behavior, or any new refresh mechanism that would affect how or when pages render after content is set.
#7355 Modify the PdfReader print behavior so that the print button prints only the PDF content displayed in the reader rather than the entire web page. The PR does not touch any print-related code, buttons, or PdfReader internals. It only updates demo markup and localized descriptions, so it cannot change what the print button prints.

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 the enhancement New feature or request label Dec 17, 2025
@bb-auto bb-auto Bot added this to the v10.1.0 milestone Dec 17, 2025
@ArgoZhang ArgoZhang changed the title feat(PdfReader): add DownloadFileNanme parameter feat(PdfReader): add IsShow parameter Dec 17, 2025
sourcery-ai[bot]
sourcery-ai Bot previously approved these changes Dec 17, 2025
Copy link
Copy Markdown
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 there - I've reviewed your changes - here's some feedback:

  • The added Localizer[...] keys like PdfReaderFAIconDesc, PdfReaderSetPdfStreamDesc, and PdfReaderDownloadFileNameDesc rely on new locale entries—double-check that they are defined consistently across all supported locale JSON files and that there are no missing or mismatched keys.
  • The hard-coded FontAwesome stylesheet link in the demo could be factored into a shared partial/component or configuration-driven helper to avoid duplication and make future asset path changes easier to manage.
  • The PR title and new text refer to DownloadFileNanme; if any parameter or API surface uses this misspelling, consider correcting it now to avoid a persistent typo in the public API.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The added `Localizer[...]` keys like `PdfReaderFAIconDesc`, `PdfReaderSetPdfStreamDesc`, and `PdfReaderDownloadFileNameDesc` rely on new locale entries—double-check that they are defined consistently across all supported locale JSON files and that there are no missing or mismatched keys.
- The hard-coded FontAwesome stylesheet link in the demo could be factored into a shared partial/component or configuration-driven helper to avoid duplication and make future asset path changes easier to manage.
- The PR title and new text refer to `DownloadFileNanme`; if any parameter or API surface uses this misspelling, consider correcting it now to avoid a persistent typo in the public API.

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.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds a DownloadFileName parameter to the PdfReader component, allowing users to specify a custom filename when downloading PDF documents. Note: The PR title contains a typo ("DownloadFileNanme" should be "DownloadFileName").

Key Changes:

  • Added documentation for the new DownloadFileName parameter in localization files
  • Added documentation about FontAwesome dependency and streaming methods
  • Updated PdfReader package version from 10.0.18 to 10.0.20

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File Description
src/BootstrapBlazor.Server/Locales/zh-CN.json Added Chinese localization strings for PdfReader documentation including FontAwesome dependency, streaming methods, and the new DownloadFileName parameter
src/BootstrapBlazor.Server/Locales/en-US.json Added English localization strings for PdfReader documentation including FontAwesome dependency, streaming methods, and the new DownloadFileName parameter
src/BootstrapBlazor.Server/Components/Samples/PdfReaders.razor Added documentation section displaying FontAwesome requirements, streaming method info, and DownloadFileName parameter usage
src/BootstrapBlazor.Server/BootstrapBlazor.Server.csproj Updated BootstrapBlazor.PdfReader package version from 10.0.18 to 10.0.20

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/BootstrapBlazor.Server/Locales/en-US.json Outdated
Comment thread src/BootstrapBlazor.Server/Locales/en-US.json Outdated
Comment thread src/BootstrapBlazor.Server/Locales/en-US.json Outdated
@codecov
Copy link
Copy Markdown

codecov Bot commented Dec 17, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (d06670c) to head (c7433ed).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #7357   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          747       747           
  Lines        32760     32760           
  Branches      4540      4540           
=========================================
  Hits         32760     32760           
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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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(PdfReader): add DownloadFileNanme parameter feat(PdfReader): render white page

2 participants