Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented May 6, 2025

Link issues

fixes #5972

Summary By Copilot

This pull request updates the ExportPdfButton component to enhance its functionality and improve its default behavior. The most notable changes involve modifying the AutoDownload property to default to true and updating its type and value list in the corresponding attributes.

Changes to ExportPdfButton behavior:

Updates to attributes:

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

Update the ExportPdfButton component to change the default AutoDownload behavior to true

New Features:

  • Changed the default AutoDownload behavior for PDF export to automatically download PDFs

Enhancements:

  • Updated documentation attributes for AutoDownload property to reflect new default value and type

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

sourcery-ai bot commented May 6, 2025

Reviewer's Guide

This pull request updates the default value of the AutoDownload property in the ExportPdfButton component to true by assigning it directly in the property declaration. Additionally, the corresponding attribute metadata in the sample file is updated to reflect this new default behavior, type, and value list.

Class diagram for ExportPdfButton changes

classDiagram
    class ExportPdfButton {
        +bool AutoDownload = true
        +Func~string, Task~ OnBeforeDownload
        +Func~string, Task~ OnAfterDownload
        +IHtml2Pdf Html2PdfService
        #Task OnClick()
        #string? GetMarkupString()
    }
    note for ExportPdfButton "AutoDownload default value changed from false to true."
Loading

File-Level Changes

Change Details Files
Set AutoDownload property default to true.
  • Initialized the AutoDownload property to true.
  • Updated the documentation comment for AutoDownload to state the new default value.
src/BootstrapBlazor/Components/Button/ExportPdfButton.cs
Update attribute metadata for AutoDownload in sample file.
  • Changed the attribute Type from string? to bool.
  • Updated the attribute ValueList to `true
false.</li><li>Set the attribute DefaultValuetotrue`.

Assessment against linked issues

Issue Objective Addressed Explanation
#5972 Update the default value of the AutoDownload property in the ExportPdfButton component to true.
#5972 Update the AutoDownload attribute in GetAttributes() to reflect its new type (bool), value list (`true false), and default value (true`).

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.6.0 milestone May 6, 2025
@ArgoZhang ArgoZhang merged commit 496004b into main May 6, 2025
4 checks passed
@ArgoZhang ArgoZhang deleted the refactor-pdf branch May 6, 2025 04:44
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:

  • Changing the default value of AutoDownload might break existing implementations relying on the previous default; consider explicitly noting this potential breaking change.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 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 May 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (e2ff294) to head (3900dd1).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5973   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          670       670           
  Lines        30606     30606           
  Branches      4352      4352           
=========================================
  Hits         30606     30606           

☔ 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(ExportPdfButton): update AutoDownload default value to true

2 participants