feat(Watermark): add IsPage parameter #5793
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Reviewer's Guide by SourceryThis pull request introduces a new Sequence diagram for creating a Watermark with IsPage=truesequenceDiagram
participant RazorComponent as Watermark Component
participant JavaScript as Watermark.razor.js
participant DOM as Document
RazorComponent->>JavaScript: Invoke createWatermark(options)
JavaScript->>JavaScript: Apply default options
JavaScript->>JavaScript: Create watermark div
alt IsPage is true
JavaScript->>DOM: document.body.appendChild(div)
else IsPage is false
JavaScript->>DOM: el.appendChild(div)
end
JavaScript->>JavaScript: requestAnimationFrame(monitor)
File-Level Changes
Assessment against linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey @ArgoZhang - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider adding a sample to the demo to showcase the new
IsPageparameter. - The exception message in
Watermark.razor.cscould be more user-friendly, perhaps suggesting an alternative approach whenIsPageis true.
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
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5793 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 658 658
Lines 30056 30062 +6
Branches 4243 4244 +1
=========================================
+ Hits 30056 30062 +6 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Link issues
fixes #5792
Summary By Copilot
This pull request introduces several enhancements and bug fixes to the
Watermarkcomponent in theBootstrapBlazorproject. The main changes include adding support for a full-page watermark, updating localization files, and refining the JavaScript and CSS for better handling of watermark properties.Enhancements to the
Watermarkcomponent:IsPageparameter to theWatermarkcomponent to support full-page watermarks. This includes updates to theOnParametersSetandOnAfterRenderAsyncmethods to handle the new parameter. [1] [2] [3]Watermark.razor.csfile to throw anInvalidOperationExceptionifIsPageis true andChildContentis set.Localization updates:
WatermarkDescriptionto bothen-US.jsonandzh-CN.jsonfiles to describe how to add a watermark globally. [1] [2]JavaScript and CSS refinements:
createWatermarkfunction inWatermark.razor.jsto handle thezIndexproperty and support full-page watermarks. [1] [2] [3] [4]Watermark.razor.scssfile to add styles for theis-pageclass, ensuring full-page watermarks are positioned correctly.Testing improvements:
WatermarkTest.csfile to include tests for the newIsPageparameter, ensuring proper exception handling and rendering behavior.Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Add support for full-page watermarks in the Watermark component by introducing an IsPage parameter and updating related JavaScript, CSS, and component logic.
New Features:
Enhancements:
Documentation:
Tests: