Skip to content

Conversation

@j4587698
Copy link
Collaborator

@j4587698 j4587698 commented Aug 12, 2025

Link issues

fixes #6608

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

Add asynchronous close callback support to the Mask component and update the samples to demonstrate its usage.

New Features:

  • Expose CloseAsync as a cascading callback in Mask to allow child content to trigger mask closure asynchronously
  • Introduce a MaskDemo component that receives the OnCloseAsync callback and renders a Close button

Enhancements:

  • Add ShowCloseMask method and corresponding DemoBlock to server samples to showcase programmatic opening and closing with the new callback

@bb-auto
Copy link

bb-auto bot commented Aug 12, 2025

Thanks for your PR, @j4587698. Someone from the team will get assigned to your PR shortly and we'll get it reviewed.

@bb-auto bb-auto bot requested a review from ArgoZhang August 12, 2025 09:12
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Aug 12, 2025

Reviewer's Guide

Introduces an OnCloseAsync callback into the Mask component, allowing child content to programmatically close the mask via a cascading parameter, and updates sample pages to demonstrate this behavior.

File-Level Changes

Change Details Files
Added OnCloseAsync callback mechanism to Mask component
  • Introduced CloseAsync method to hide mask by calling Show(null)
  • Wrapped ChildContent in a CascadingValue supplying CloseAsync
  • Created MaskDemo component consuming OnCloseAsync via cascading parameter and invoking it on button click
src/BootstrapBlazor/Components/Mask/Mask.razor.cs
src/BootstrapBlazor/Components/Mask/Mask.razor
src/BootstrapBlazor.Server/Components/Components/MaskDemo.razor
Updated sample to demonstrate Mask close callback
  • Added ShowCloseMask method to Samples/Masks.razor.cs to display MaskDemo component
  • Introduced a DemoBlock and Show button in Samples/Masks.razor to trigger the new mask example
src/BootstrapBlazor.Server/Components/Samples/Masks.razor.cs
src/BootstrapBlazor.Server/Components/Samples/Masks.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#6608 Enable MaskService to be closed from within its own content (i.e., allow internal closing).

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

@bb-auto bb-auto bot added the enhancement New feature or request label Aug 12, 2025
@bb-auto bb-auto bot added this to the 9.9.0 milestone Aug 12, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Aug 12, 2025
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 @j4587698 - I've reviewed your changes - here's some feedback:

  • Rename the cascading delegate name from CloseAsync to something more descriptive like OnMaskCloseAsync to avoid generic naming and improve clarity.
  • Consider adding an OnCloseAsync callback property on MaskOption so consumers can hook into the close event directly instead of relying solely on a CascadingParameter.
  • Expose the CloseAsync method (or a similarly named public API) on the Mask component or MaskService to allow programmatic closing without requiring a CascadingParameter.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Rename the cascading delegate name from `CloseAsync` to something more descriptive like `OnMaskCloseAsync` to avoid generic naming and improve clarity.
- Consider adding an `OnCloseAsync` callback property on `MaskOption` so consumers can hook into the close event directly instead of relying solely on a CascadingParameter.
- Expose the `CloseAsync` method (or a similarly named public API) on the Mask component or MaskService to allow programmatic closing without requiring a CascadingParameter.

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 12, 2025

Codecov Report

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

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6609   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          739       739           
  Lines        31669     31672    +3     
  Branches      4458      4458           
=========================================
+ Hits         31669     31672    +3     
Flag Coverage Δ
BB 100.00% <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(Mask): support DialogCloseButton

3 participants