feat(Drawer): add BodyScroll parameter #5311
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Reviewer's Guide by SourceryThis pull request adds a BodyScroll parameter to the Drawer component, allowing users to control whether the body scrolls when the drawer is open. Sequence diagram for Drawer opening behaviorsequenceDiagram
participant U as User
participant D as Drawer
participant JS as JavaScript
participant B as Body Element
U->>D: Open Drawer
D->>JS: execute(id, open=true)
JS->>D: Add 'show' class
alt BodyScroll is false
JS->>B: Add 'drawer-overflow-hidden' class
end
Note over JS: Animation frame requested
U->>D: Close Drawer
D->>JS: execute(id, open=false)
JS->>D: Remove 'show' class
JS->>B: Remove 'drawer-overflow-hidden' class
Class diagram showing Drawer component changesclassDiagram
class Drawer {
+bool IsOpen
+bool IsKeyboard
+bool BodyScroll
-string? KeyboardString
-string? BodyScrollString
}
class DrawerOption {
+bool ShowBackdrop
+bool BodyScroll
+Placement Placement
}
note for Drawer "Added BodyScroll parameter
to control body scrolling"
note for DrawerOption "Added BodyScroll option
for service-based usage"
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey @ArgoZhang - I've reviewed your changes - here's some feedback:
Overall Comments:
- In Drawer.razor.js, the condition 'if (scroll === false)' could be simplified to 'if (!scroll)' for better readability and clarity.
- The change from using 'overflow-hidden' to 'drawer-overflow-hidden' in both JS and SCSS should be verified to ensure it doesn't unintentionally affect other components or conflicting styles.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟡 Testing: 2 issues found
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5311 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 644 644
Lines 28918 28922 +4
Branches 4110 4111 +1
=========================================
+ Hits 28918 28922 +4 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
add BodyScroll parameter
Summary of the changes (Less than 80 chars)
简单描述你更改了什么, 不超过80个字符；如果有关联 Issue 请在下方填写相关编号
Description
fixes #5304
Regression?
[If yes, specify the version the behavior has regressed from]
[是否影响老版本]
Risk
[Justify the selection above]
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
New Features:
BodyScrollparameter to theDrawercomponent.