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): add back/restoreBodyStyle function #5544

Merged
merged 4 commits into from
Mar 6, 2025
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Mar 6, 2025

Link issues

fixes #5543
[Please fill in the relevant Issue number after the # above, such as #42]
[请在上方 # 后面填写相关 Issue 编号,如 #42]

Summary By Copilot

This pull request includes refactoring of the Modal component in src/BootstrapBlazor/Components/Modal/Modal.razor.js to improve the handling of the document body style when showing and hiding modals. The most important changes include the introduction of helper functions to backup and restore the body style.

Refactoring of modal body style handling:

  • src/BootstrapBlazor/Components/Modal/Modal.razor.js: Replaced inline style backup and restore logic with backupBodyStyle and restoreBodyStyle helper functions in modal.show, modal.hide, and dispose functions. [1] [2] [3]
  • Added backupBodyStyle function to store the original body style in modal.originalStyle if it is not already set.
  • Added restoreBodyStyle function to revert the body style to the original and delete modal.originalStyle if it is set.

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

Enhancements:

  • Introduces helper functions backupBodyStyle and restoreBodyStyle to manage the document body style, improving code readability and maintainability.

Copy link

sourcery-ai bot commented Mar 6, 2025

Reviewer's Guide by Sourcery

This pull request refactors the Modal component to improve the handling of the document body style when showing and hiding modals by introducing helper functions to backup and restore the body style.

Sequence diagram for hiding the modal

sequenceDiagram
    participant document
    participant modal

    document->>modal: modal.hide()
    activate modal
    modal->>modal: modal.modal.hide()
    modal->>modal: restoreBodyStyle(modal)
    alt modal.originalStyle is defined
        modal->>document: document.body.style.cssText = modal.originalStyle
        modal->>modal: delete modal.originalStyle
    end
    modal->>modal: invoke.invokeMethodAsync(modal.closeCallback)
    deactivate modal
Loading

File-Level Changes

Change Details Files
Encapsulated the logic for backing up and restoring the document body style into separate functions.
  • Added backupBodyStyle function to store the original body style.
  • Added restoreBodyStyle function to revert the body style to the original.
src/BootstrapBlazor/Components/Modal/Modal.razor.js
Refactored the modal.show, modal.hide, and dispose functions to use the new helper functions for managing the body style.
  • Replaced inline style backup logic in modal.show with backupBodyStyle function.
  • Replaced inline style restore logic in modal.hide with restoreBodyStyle function.
  • Replaced inline style restore logic in dispose with restoreBodyStyle function.
src/BootstrapBlazor/Components/Modal/Modal.razor.js

Assessment against linked issues

Issue Objective Addressed Explanation
#5543 Add back/restoreBodyStyle function to the Modal component.

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

  • Consider adding comments to the helper functions to explain their purpose.
  • It might be clearer to use modal.originalStyle === undefined instead of modal.originalStyle ??= ... and modal.originalStyle !== undefined instead of modal.originalStyle.
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 enabled auto-merge (squash) March 6, 2025 06:17
Copy link

codecov bot commented Mar 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (1381afe) to head (a81a345).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5544   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          649       649           
  Lines        29607     29607           
  Branches      4173      4173           
=========================================
  Hits         29607     29607           

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

@ArgoZhang ArgoZhang merged commit f93cb6f into main Mar 6, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-modal branch March 6, 2025 06:18
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): add back/restoreBodyStyle function
1 participant