Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Aug 20, 2025

Link issues

fixes #6660

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 Dom2Image export service by defining the IDom2ImageService interface, registering it in DI, and showcasing its usage with a dedicated demo component and menu entry, along with localization and documentation updates.

New Features:

  • Introduce IDom2ImageService interface to support HTML-to-image conversion.
  • Add Dom2Images sample component and razor page demonstrating GetUrlAsync and DownloadAsync methods.

Enhancements:

  • Register BootstrapBlazorDom2ImageService in IServiceCollection and add a Dom2Image demo menu item.
  • Update localization entries for Dom2Image in en-US and zh-CN resource files.

Documentation:

  • Add Dom2Image feature documentation entry in docs.json.

Chores:

  • Remove unused IconTheme and NavigationManager injections from the Html2Images sample.

@bb-auto bb-auto bot added the enhancement New feature or request label Aug 20, 2025
@bb-auto bb-auto bot added this to the 9.9.0 milestone Aug 20, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Aug 20, 2025

Reviewer's Guide

This PR adds a new DOM-to-image export feature by introducing the IDom2ImageService interface and its service registration, provides a full Blazor sample with interaction methods, integrates the feature into localizations and menu, and cleans up obsolete injections from the existing Html2Images sample.

Sequence diagram for Dom2Images export interactions

sequenceDiagram
    actor User
    participant Dom2Images
    participant IDom2ImageService
    User->>Dom2Images: Clicks 'GetUrl' button
    Dom2Images->>IDom2ImageService: GetUrlAsync("#table-9527")
    IDom2ImageService-->>Dom2Images: Returns image data
    Dom2Images-->>User: Displays image
    User->>Dom2Images: Clicks 'Download' button
    Dom2Images->>IDom2ImageService: DownloadAsync("#table-9527", fileName)
    IDom2ImageService-->>Dom2Images: (Download triggered)
    User->>Dom2Images: Clicks 'Full' button
    Dom2Images->>IDom2ImageService: DownloadAsync(".tabs-body-content:not(.d-none)", fileName)
    IDom2ImageService-->>Dom2Images: (Download triggered)
Loading

File-Level Changes

Change Details Files
Introduce Dom2Image export service and sample implementation
  • Register Dom2Image service in DI container
  • Implement Dom2Images component with injection of IDom2ImageService
  • Add component logic: GetUrlAsync, DownloadAsync, Full export methods
ServiceCollectionSharedExtensions.cs
Components/Samples/Dom2Images.razor.cs
Components/Samples/Dom2Images.razor
Integrate Dom2Image feature into UI and documentation
  • Add new menu entry for Dom2ImageService
  • Update localization resources with Dom2Image texts
  • Add documentation entry in docs.json
MenusLocalizerExtensions.cs
Locales/en-US.json
Locales/zh-CN.json
docs.json
Clean up obsolete injections in existing Html2Images sample
  • Remove IconTheme injection
  • Remove NavigationManager injection
Components/Samples/Html2Images.razor.cs
Update project file for Dom2Image package reference
  • Include BootstrapBlazor.Dom2Image package in the server project
BootstrapBlazor.Server.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#6660 Add the IDom2ImageService interface to the codebase.

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 enabled auto-merge (squash) August 20, 2025 06: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 there - I've reviewed your changes - here's some feedback:

  • Make sure the new Dom2Image library is added as a PackageReference in the server .csproj so that AddBootstrapBlazorDom2ImageService and IDom2ImageService resolve correctly.
  • Add all missing localization keys (e.g. Dom2ImageTitle, Dom2ImageIntro, Dom2ImageNormalTitle, etc.) to your en-US.json and zh-CN.json so the new sample page texts load without errors.
  • Consider unifying the component naming (Dom2Image vs Dom2Images) and extracting your CSS selectors (like "#table-9527") into constants to avoid magic strings and improve maintainability.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Make sure the new Dom2Image library is added as a PackageReference in the server .csproj so that AddBootstrapBlazorDom2ImageService and IDom2ImageService resolve correctly.
- Add all missing localization keys (e.g. Dom2ImageTitle, Dom2ImageIntro, Dom2ImageNormalTitle, etc.) to your en-US.json and zh-CN.json so the new sample page texts load without errors.
- Consider unifying the component naming (Dom2Image vs Dom2Images) and extracting your CSS selectors (like "#table-9527") into constants to avoid magic strings and improve maintainability.

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 Aug 20, 2025

Codecov Report

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

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6661   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          739       739           
  Lines        31667     31667           
  Branches      4459      4459           
=========================================
  Hits         31667     31667           
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(IDom2ImageService): add IDom2ImageService interface

2 participants