Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 12, 2025

add Watermark component

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #5098

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

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

Add a new Watermark component.

New Features:

  • Introduce a new component for creating watermarks on content.

Tests:

  • Add unit tests for the Watermark component.

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

sourcery-ai bot commented Jan 12, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new Watermark component. It includes a JavaScript module for dynamic watermark creation and updates, a C# component for rendering, and integration with existing components and localization.

Sequence diagram for Watermark component initialization and updates

sequenceDiagram
    participant C as Component
    participant JS as JavaScript Module
    participant Canvas as Canvas API
    C->>JS: init(id, options)
    JS->>Canvas: Create canvas element
    JS->>Canvas: Set font and context
    Canvas->>Canvas: Draw watermark text
    Canvas-->>JS: Return base64 image
    JS->>JS: Create watermark div
    JS->>JS: Setup mutation observer
    Note over JS: Monitor DOM changes
    JS-->>C: Watermark initialized
    Note over C,JS: When properties change
    C->>JS: update(id, options)
    JS->>Canvas: Recreate watermark
    Canvas-->>JS: Return new base64 image
    JS->>JS: Update watermark div
Loading

File-Level Changes

Change Details Files
Added a new Watermark component.
  • Created the Watermark component in C# and JavaScript.
  • Implemented dynamic watermark creation and updates.
  • Added a sample page for demonstration.
  • Added unit tests for the component.
  • Integrated the component with existing localization and styling.
src/BootstrapBlazor/Components/Watermark/Watermark.razor
src/BootstrapBlazor/Components/Watermark/Watermark.razor.cs
src/BootstrapBlazor/Components/Watermark/Watermark.razor.js
src/BootstrapBlazor/Components/Watermark/Watermark.razor.scss
src/BootstrapBlazor.Server/Components/Samples/Watermarks.razor
src/BootstrapBlazor.Server/Components/Samples/Watermarks.razor.cs
test/UnitTest/Components/WatermarkTest.cs
Updated project files and documentation.
  • Added the Watermark component to the project file.
  • Updated the documentation to include the new component.
  • Added menu item for the new component.
  • Added localized strings for the new component.
  • Included the component's stylesheet in the main stylesheet.
src/BootstrapBlazor/BootstrapBlazor.csproj
src/BootstrapBlazor.Server/docs.json
src/BootstrapBlazor.Server/Extensions/MenusLocalizerExtensions.cs
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
src/BootstrapBlazor/wwwroot/scss/components.scss

Assessment against linked issues

Issue Objective Addressed Explanation
#5098 Add a Watermark component to the BootstrapBlazor library
#5098 Implement configurable watermark functionality with customizable text, font size, color, rotation, and gap
#5098 Provide a demo and documentation for the new Watermark component

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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.2.0 milestone Jan 12, 2025
@ArgoZhang ArgoZhang enabled auto-merge (squash) January 12, 2025 12:05
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 and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟢 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 Jan 12, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (0d7e077) to head (11693d4).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5099   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          632       633    +1     
  Lines        28105     28136   +31     
  Branches      4034      4036    +2     
=========================================
+ Hits         28105     28136   +31     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ArgoZhang ArgoZhang merged commit ae7d91b into main Jan 12, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-watermark branch January 12, 2025 12:51
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(Watermark): add Watermark component

2 participants