Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(Modal): use BootstrapBlazorRootOutlet wrap Modal component #5595

Merged
merged 18 commits into from
Mar 10, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Mar 10, 2025

Link issues

fixes #5594

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

Refactors the Modal component to use BootstrapBlazorRootOutlet to wrap the Modal component, ensuring proper rendering and functionality within the BootstrapBlazor framework. This change addresses issue #5594.

Enhancements:

  • Wraps the Modal component with BootstrapBlazorRootOutlet to improve rendering and integration within the BootstrapBlazor framework.
  • Updates unit tests to reflect the changes in the Modal component's rendering structure.
  • Removes the swal div and moves the Modal component to the root.
  • Updates the main and base layout to have relative positioning and z-index

Copy link

sourcery-ai bot commented Mar 10, 2025

Reviewer's Guide by Sourcery

This pull request refactors the Modal component to be wrapped by BootstrapBlazorRootOutlet. This change ensures that the Modal component is correctly integrated within the BootstrapBlazor framework, resolving issues related to rendering and styling. The changes include modifications to the Modal's Razor markup, associated CSS/SCSS files, and updates to unit tests to reflect the new structure.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Wrapped the Modal component with BootstrapBlazorRootOutlet to ensure proper rendering and integration with the Bootstrap Blazor framework.
  • Wrapped Modal components in test files with BootstrapBlazorRoot or BootstrapBlazorRootOutlet.
  • Modified Modal.razor to use BootstrapBlazorRootContent.
  • Updated SweetAlert.razor to directly use Modal instead of wrapping it in a div.
  • Adjusted CSS and SCSS files to accommodate the new structure and prevent conflicts.
  • Updated test assertions to reflect the new DOM structure.
test/UnitTest/Components/ModalTest.cs
src/BootstrapBlazor/Components/Modal/Modal.razor.cs
src/BootstrapBlazor/Components/SweetAlert/SweetAlert.razor.cs
src/BootstrapBlazor/Components/Modal/Modal.razor
src/BootstrapBlazor/Services/BootstrapBlazorRootRegisterService.cs
test/UnitTest/Components/InputTest.cs
src/BootstrapBlazor/Components/SweetAlert/SweetAlert.razor
src/BootstrapBlazor/Components/SweetAlert/SweetAlert.razor.scss
src/BootstrapBlazor/Components/Dialog/Dialog.razor.cs
src/BootstrapBlazor/wwwroot/scss/root.scss
src/BootstrapBlazor.Server/Components/Layout/BaseLayout.razor.css
src/BootstrapBlazor.Server/Components/Layout/MainLayout.razor.css
src/BootstrapBlazor/Components/Modal/ModalDialog.razor
test/UnitTest/Components/ErrorHandlerTest.cs
src/BootstrapBlazor/Components/Modal/ModalDialog.razor.cs
test/UnitTest/Components/TableDialogTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5594 Refactor the Modal component to use BootstrapBlazorRootOutlet to ensure proper rendering and positioning within the Bootstrap Blazor framework.

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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 Mar 10, 2025
@bb-auto bb-auto bot added this to the v9.4.0 milestone Mar 10, 2025
Copy link

@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 - here's some feedback:

Overall Comments:

  • The changes to ModalTest.cs look good, but the tests are now creating a BootstrapBlazorRoot component, but not disposing of it.
  • Consider adding a CSS class to the Modal component instead of relying on AdditionalAttributes for styling.
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

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.

@ArgoZhang ArgoZhang merged commit 809ede2 into main Mar 10, 2025
3 checks passed
@ArgoZhang ArgoZhang deleted the refactor-modal branch March 10, 2025 11:39
Copy link

codecov bot commented Mar 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (950d7b4) to head (2cc394e).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5595   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          649       649           
  Lines        29629     29629           
  Branches      4169      4165    -4     
=========================================
  Hits         29629     29629           

☔ 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.

refactor(Modal): use BootstrapBlazorRootOutlet wrap Modal component
1 participant