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

fix(ModalDialog): overflow top when set IsDraggable to true #4995

Merged
merged 4 commits into from
Dec 30, 2024
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Dec 30, 2024

overflow top when set IsDraggable to true

Summary of the changes (Less than 80 chars)

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

Description

fixes #4994

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

Bug Fixes:

  • Fix the modal dialog overflow issue when "IsDraggable" is set to true.

Copy link

sourcery-ai bot commented Dec 30, 2024

Reviewer's Guide by Sourcery

This PR fixes a bug where the modal dialog overflows at the top when the IsDraggable property is set to true. The fix involves updating the JavaScript code to dynamically calculate the top margin of the modal, taking into account the viewport height and the modal's height. This ensures that the modal is always fully visible within the viewport, even when dragged.

Sequence diagram for Modal Dialog positioning calculation

sequenceDiagram
    participant M as Modal Dialog
    participant JS as JavaScript
    participant W as Window

M->>JS: init(id)
JS->>M: Get element
JS->>M: Get offsetHeight
JS->>W: Get innerHeight
JS->>M: Get computedStyle.marginTop
Note over JS: Calculate if modal fits in viewport
alt Modal fits in viewport
    JS->>M: Set margin-top = 50vh - height
end
JS->>M: Set margin-left = 50vw - width
JS->>M: Remove 'is-draggable-center' class
Loading

State diagram for Modal Dialog positioning logic

stateDiagram-v2
    [*] --> CheckPosition
    CheckPosition --> FitsInViewport: viewBoxHeight - height - marginTop > 0
    CheckPosition --> DefaultPosition: viewBoxHeight - height - marginTop <= 0
    FitsInViewport --> SetCenteredPosition: Set margin-top = 50vh - height
    DefaultPosition --> KeepCurrentPosition
    SetCenteredPosition --> UpdateHorizontalPosition
    KeepCurrentPosition --> UpdateHorizontalPosition
    UpdateHorizontalPosition --> RemoveDraggableCenter
    RemoveDraggableCenter --> [*]
Loading

File-Level Changes

Change Details Files
Dynamically calculate top margin
  • Added logic to calculate the top margin based on the viewport height and modal height.
  • Removed the fixed calculation of the top margin.
  • Added a conditional check to ensure the modal is always within the viewport when dragged to the top.
  • Updated the calculation of the left margin to ensure the modal remains centered horizontally.
src/BootstrapBlazor/Components/Modal/ModalDialog.razor.js
Update project file
  • Updated the project file to reflect the changes in the JavaScript file.
src/BootstrapBlazor/BootstrapBlazor.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#4994 When the modal dialog is draggable and its height exceeds the viewport height, ensure the title bar is accessible by scrolling
#4994 Fix the positioning of the modal dialog when IsDraggable is set to true and the dialog is taller than the screen

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 the bug Something isn't working label Dec 30, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Dec 30, 2024
@ArgoZhang ArgoZhang enabled auto-merge (squash) December 30, 2024 03:22
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:

  • Please complete the PR template fully, including risk assessment and verification details. This helps maintainers better understand and review the changes.
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.

Copy link

codecov bot commented Dec 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d56df66) to head (3261be7).
Report is 13 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4995   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          630       630           
  Lines        28099     28105    +6     
  Branches      4036      4030    -6     
=========================================
+ Hits         28099     28105    +6     

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

@ArgoZhang ArgoZhang merged commit 3d6591e into main Dec 30, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the fix-dialog branch December 30, 2024 03:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bug(Dialog): 设置可拖动后超高弹窗无法显示标题栏
1 participant