Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Aug 23, 2025

Link issues

fixes #6674

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

Update MaskOption documentation to incorporate ZIndex details by extending the Razor demo with a hidden description block and refreshing locale strings.

Enhancements:

  • Add a hidden description section in the Mask demo to render the localized MaskNormalDesc value

Documentation:

  • Update en-US.json and zh-CN.json locale files with MaskNormalDesc entries for ZIndex documentation

Copilot AI review requested due to automatic review settings August 23, 2025 12:22
@bb-auto bb-auto bot added the documentation Improvements or additions to documentation label Aug 23, 2025
@bb-auto bb-auto bot added this to the 9.9.0 milestone Aug 23, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Aug 23, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR fixes #6674 by enhancing the MaskOption sample with ZIndex documentation: it injects an ignored inline section to display localized MaskNormalDesc in the demo and updates the English and Chinese locale files with the corresponding translation entries.

File-Level Changes

Change Details Files
Add inline MaskOption description in sample component
  • Inserted a
    wrapper under the Normal demo block
  • Rendered localized MaskNormalDesc value using MarkupString
src/BootstrapBlazor.Server/Components/Samples/Masks.razor
Update localization JSON files with new MaskOption description entries
  • Added MaskNormalDesc key and value to en-US.json
  • Added MaskNormalDesc key and value to zh-CN.json
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json

Assessment against linked issues

Issue Objective Addressed Explanation
#6674 Update the documentation for the ZIndex property in MaskOption.

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

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds documentation for the MaskOption parameters (ZIndex, Opacity, BackgroundColor) to help users understand the available configuration options for mask components.

  • Adds localized description text for MaskOption parameters in both English and Chinese
  • Updates the Masks demo component to display the new documentation text

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
src/BootstrapBlazor.Server/Locales/zh-CN.json Adds Chinese localization for MaskOption parameters description
src/BootstrapBlazor.Server/Locales/en-US.json Adds English localization for MaskOption parameters description
src/BootstrapBlazor.Server/Components/Samples/Masks.razor Displays the new documentation text in the demo section

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@ArgoZhang ArgoZhang merged commit 9314754 into main Aug 23, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the doc-mask branch August 23, 2025 12:22
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 and found some issues that need to be addressed.

Blocking issues:

  • Directly rendering localized HTML via MarkupString may introduce XSS risks. (link)
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `src/BootstrapBlazor.Server/Components/Samples/Masks.razor:10` </location>
<code_context>

 <DemoBlock Title="@Localizer["MaskNormalTitle"]" Introduction="@Localizer["MaskNormalIntro"]" Name="Normal">
+    <section ignore>
+        <div>@((MarkupString)Localizer["MaskNormalDesc"].Value)</div>
+    </section>
     <button class="btn btn-primary" @onclick="@ShowMask">@Localizer["ShowMaskButtonText"]</button>
</code_context>

<issue_to_address>
Directly rendering localized HTML via MarkupString may introduce XSS risks.

Sanitize or validate all localized content before rendering as raw HTML to prevent XSS vulnerabilities.
</issue_to_address>

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.


<DemoBlock Title="@Localizer["MaskNormalTitle"]" Introduction="@Localizer["MaskNormalIntro"]" Name="Normal">
<section ignore>
<div>@((MarkupString)Localizer["MaskNormalDesc"].Value)</div>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚨 issue (security): Directly rendering localized HTML via MarkupString may introduce XSS risks.

Sanitize or validate all localized content before rendering as raw HTML to prevent XSS vulnerabilities.

@codecov
Copy link

codecov bot commented Aug 23, 2025

Codecov Report

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

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6675   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          739       739           
  Lines        31698     31698           
  Branches      4462      4462           
=========================================
  Hits         31698     31698           
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

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc(MaskOption): update ZIndex documentation

1 participant