Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix(dialog-box): [dialog-box] modify the style of the dialog box #2757

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

Merged
merged 1 commit into from
Jan 8, 2025

Conversation

James-9696
Copy link
Collaborator

@James-9696 James-9696 commented Jan 8, 2025

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:
    Modify the style of the dialog box

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features

    • Enhanced dialog box styling with improved vertical padding
    • Added scrollable content area with maximum height of 65% viewport height
  • Style

    • Introduced new vertical padding variable for more flexible dialog box layout
    • Enabled automatic overflow handling for dialog box content

Copy link

coderabbitai bot commented Jan 8, 2025

Walkthrough

The pull request introduces modifications to the dialog box component's styling in the theme package. The changes focus on enhancing the dialog box's body section by adding vertical padding and implementing scrolling behavior. A new CSS variable for vertical padding is introduced, allowing more flexible styling. The modifications aim to improve the dialog box's layout and usability, particularly when dealing with content that exceeds the viewport height.

Changes

File Change Summary
packages/theme/src/dialog-box/index.less - Updated padding to use separate vertical and horizontal values
- Added overflow: auto to enable scrolling
- Set max-height: 65vh to limit body height
packages/theme/src/dialog-box/vars.less - Added new CSS variable --tv-DialogBox-vertical-padding with value var(--tv-space-xs)

Possibly related PRs

Suggested labels

enhancement

Suggested reviewers

  • zzcr

Poem

🐰 Hop, hop, dialog box so neat,
Scrolling now with padding sweet,
Vertical space, a rabbit's delight,
Viewport dancing, content just right!
CSS magic, smooth and clean! 🎩


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the bug Something isn't working label Jan 8, 2025
Copy link

Walkthrough

This PR modifies the style of the dialog box by adjusting padding, adding overflow and max-height properties to improve layout and usability. It introduces a new CSS variable for vertical padding.

Changes

File Summary
packages/theme/src/dialog-box/index.less Adjusted padding, added overflow and max-height properties to dialog box body.
packages/theme/src/dialog-box/vars.less Introduced a new CSS variable for vertical padding.

color: var(--tv-DialogBox-body-text-color);
font-size: var(--tv-DialogBox-body-font-size);
overflow: auto;
max-height: 65vh;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure that the max-height of 65vh does not cause content clipping in smaller viewports. Consider making this value responsive if necessary.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
packages/theme/src/dialog-box/vars.less (1)

57-58: LGTM! Consider adding English comments.

The new CSS variable follows the existing naming convention and properly uses the design system's spacing scale. However, consider adding English translations for comments to maintain consistency with the project's international nature.

-  // 弹窗容器与上下内容间距
+  // 弹窗容器与上下内容间距
+  // Vertical padding between dialog container and content
   --tv-DialogBox-vertical-padding: var(--tv-space-xs);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6e29e24 and 001b71c.

📒 Files selected for processing (2)
  • packages/theme/src/dialog-box/index.less (1 hunks)
  • packages/theme/src/dialog-box/vars.less (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: PR E2E Test (pnpm test:e2e3)
🔇 Additional comments (1)
packages/theme/src/dialog-box/index.less (1)

119-119: LGTM! Padding implementation looks good.

The padding implementation correctly uses the new vertical padding variable while maintaining the existing horizontal padding.

Comment on lines +122 to +123
overflow: auto;
max-height: 65vh;
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

🛠️ Refactor suggestion

Consider implementing responsive max-height with CSS custom properties

The codebase analysis confirms the review's concerns:

  • Other components like Tooltip use CSS custom properties for vh-based heights
  • No mobile-specific height adjustments exist
  • Current fixed 65vh value lacks configurability

The suggested improvements in the review are valid and align with the existing patterns in the codebase.

🔗 Analysis chain

Review max-height implementation for mobile responsiveness.

The current implementation has potential issues:

  1. Fixed max-height: 65vh might not work well on smaller screens
  2. Could conflict with .is-fullscreen behavior
  3. No mobile-specific adjustments for the max-height

Consider these improvements:

  1. Add mobile-specific max-height adjustment
  2. Handle interaction with .is-fullscreen class
  3. Consider using CSS custom properties for configurable heights
 &__body {
   text-align: left;
   padding: var(--tv-DialogBox-vertical-padding) var(--tv-DialogBox-padding);
   color: var(--tv-DialogBox-body-text-color);
   font-size: var(--tv-DialogBox-body-font-size);
   overflow: auto;
-  max-height: 65vh;
+  max-height: var(--tv-DialogBox-body-max-height, 65vh);
 }

 &.is-fullscreen &__body {
   flex: 1;
   overflow: scroll;
+  max-height: none;  // Override max-height when fullscreen
 }

 @media (max-width: 480px) {
   .@{dialog-box-prefix-cls} {
     width: 100% !important;
     top: 0 !important;
     left: 0 !important;
+    &__body {
+      max-height: var(--tv-DialogBox-body-max-height-mobile, 80vh);
+    }
   }
 }

Let me verify the current mobile handling in the codebase:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for other mobile-specific dialog box styles and max-height usage
rg -l "max-height.*vh" packages/theme/src/
rg -l "@media.*480px" packages/theme/src/

Length of output: 282


Script:

#!/bin/bash
# Check vh-based max-height implementations and fullscreen styles
rg "max-height:.*vh" packages/theme/src/ -A 2
rg "is-fullscreen" packages/theme/src/
rg "tv-DialogBox.*height" packages/theme/src/

Length of output: 1068

@zzcr zzcr merged commit d4228d9 into dev Jan 8, 2025
10 of 11 checks passed
@kagol kagol deleted the fix-dialog-box-0108 branch April 14, 2025 12:20
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.

2 participants