doc(IDom2HtmlService): update documentation#7885
Conversation
Agent-Logs-Url: https://github.com/dotnetcore/BootstrapBlazor/sessions/1f0099c2-9925-4e47-81b7-ffec60040f2d Co-authored-by: h2ls <33386249+h2ls@users.noreply.github.com>
Agent-Logs-Url: https://github.com/dotnetcore/BootstrapBlazor/sessions/1f0099c2-9925-4e47-81b7-ffec60040f2d Co-authored-by: h2ls <33386249+h2ls@users.noreply.github.com>
|
Thanks for your PR, @copilot. Someone from the team will get assigned to your PR shortly and we'll get it reviewed. |
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates the Dom2Images sample documentation to show required DI setup for Dom2Image and SignalR message-size configuration, and wires corresponding localized strings in both en-US and zh-CN locale files. Sequence diagram for Dom2Images sample using Dom2Image service and SignalRsequenceDiagram
actor User
participant Browser
participant Dom2ImagesPage
participant DIContainer
participant Dom2ImageService
participant SignalRHubDom2Image
User->>Browser: Navigate to Dom2Images sample
Browser->>Dom2ImagesPage: Render page
Dom2ImagesPage->>DIContainer: Request Dom2ImageService
DIContainer-->>Dom2ImagesPage: Provide Dom2ImageService instance
User->>Browser: Trigger capture to image
Browser->>Dom2ImagesPage: Invoke capture handler
Dom2ImagesPage->>Dom2ImageService: Convert DOM to image payload
Dom2ImageService-->>Dom2ImagesPage: Image payload
Dom2ImagesPage->>SignalRHubDom2Image: Send image over SignalR
Note over SignalRHubDom2Image: Enforces MaximumReceiveMessageSize (e.g. 10 MB)
SignalRHubDom2Image-->>Dom2ImagesPage: Acknowledge or broadcast result
Dom2ImagesPage-->>Browser: Update UI with generated image
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Pull request overview
Updates the Dom2Image sample documentation in the BootstrapBlazor.Server demo to clarify required runtime setup (service registration + SignalR payload size) and provides the same guidance in both en-US and zh-CN locales.
Changes:
- Add a Tips block to the Dom2Images sample page showing DI registration and SignalR payload configuration guidance.
- Add localized strings (en-US / zh-CN) for the new guidance.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/BootstrapBlazor.Server/Locales/zh-CN.json | Adds zh-CN localized tips for Dom2Image setup guidance. |
| src/BootstrapBlazor.Server/Locales/en-US.json | Adds en-US localized tips for Dom2Image setup guidance. |
| src/BootstrapBlazor.Server/Components/Samples/Dom2Images.razor | Renders the new localized Tips block and configuration snippets on the Dom2Image sample page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7885 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 764 764
Lines 34173 34173
Branches 4702 4702
=========================================
Hits 34173 34173
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Link issues
close #7890
Summary By Copilot
Dom2Image docs were missing required runtime setup details, which could cause service resolution or large-payload transfer failures.
This update adds explicit bilingual guidance for both manual service registration and SignalR message-size configuration.
Dom2Images demo doc content
Tipsblock inDom2Images.razorbefore the demo.MaximumReceiveMessageSizesetup using a concrete10 MBexample.Localization (zh-CN / en-US)
Dom2ImageServiceInjectTipDom2ImageSignalRConfigTipRegression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Document required runtime configuration for the Dom2Images sample, including DI setup and SignalR payload limits.
Documentation: