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(dropdown): [dropdown] fix icon shaking when hover #2557

Merged
merged 1 commit into from
Nov 26, 2024

Conversation

MomoPoppy
Copy link
Collaborator

@MomoPoppy MomoPoppy commented Nov 26, 2024

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:

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 layout and alignment for the dropdown component's trigger and suffix elements.
    • Introduced a new variable for horizontal margin adjustments, improving styling flexibility.
  • Bug Fixes

    • Improved alignment of child elements in dropdown components for better user experience.

Copy link

coderabbitai bot commented Nov 26, 2024

Walkthrough

The changes made in this pull request involve modifications to the CSS styles of the dropdown component, specifically in the index.less and vars.less files. The updates include adjustments to layout properties, the introduction of new inner classes for better alignment, and a renaming of a CSS variable to generalize margin usage. These changes aim to enhance the dropdown's layout and alignment while maintaining existing functionality.

Changes

File Path Change Summary
packages/theme/src/dropdown/index.less Updated .tiny-dropdown__trigger, .tiny-dropdown__suffix-inner, and button group class for layout adjustments. Introduced .tiny-dropdown__prefix-inner class.
packages/theme/src/dropdown/vars.less Renamed variable --tv-Dropdown-icon-margin-left to --tv-Dropdown-icon-margin-x for generalized margin application.

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • zzcr
  • kagol

🐇 In the dropdown, a tweak we find,
With flex and margins, all aligned.
A prefix here, a suffix there,
Our styles now dance with flair!
So let’s hop along, with joy we sing,
For dropdowns bright, new changes bring! 🎉


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 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 Nov 26, 2024
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: 0

🧹 Outside diff range and nitpick comments (2)
packages/theme/src/dropdown/vars.less (1)

18-18: Consider documenting hover state best practices.

Since this fix addresses icon shaking on hover, consider:

  1. Adding a comment explaining the importance of consistent margins for hover stability
  2. Creating a shared documentation or guideline for handling hover states across components to prevent similar issues
packages/theme/src/dropdown/index.less (1)

Line range hint 143-144: Consider translating the Chinese comment to English for better maintainability.

The comment explains an important implementation detail about using scaleY(-1) instead of rotate(180deg) to prevent position shifts.

- /* 下拉图标旋转 */
+ /* Dropdown icon rotation */
  &--visible {
-    transform: scaleY(-1); // rotate(180deg) 会受svg的margin影响,位置会变动!
+    transform: scaleY(-1); // Using scaleY instead of rotate(180deg) to prevent position shifts caused by SVG margins
    transform-origin: center;
  }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fdd92dd and dfc7c1a.

📒 Files selected for processing (2)
  • packages/theme/src/dropdown/index.less (2 hunks)
  • packages/theme/src/dropdown/vars.less (1 hunks)
🔇 Additional comments (3)
packages/theme/src/dropdown/vars.less (1)

18-18: Good improvement in variable naming, but let's verify the complete fix.

The renaming from --tv-Dropdown-icon-margin-left to --tv-Dropdown-icon-margin-x is a good change as it:

  • Provides more flexibility for bidirectional layouts (LTR/RTL)
  • Allows for consistent horizontal spacing

Let's verify if this change, combined with its usage in index.less, properly addresses the icon shaking:

✅ Verification successful

Icon shaking fix is properly implemented with consistent margins

The verification shows the new --tv-Dropdown-icon-margin-x variable is correctly applied:

  • Used for margin-right in prefix elements
  • Used for margin-left in suffix elements
  • No traces of the old variable name remain
  • The suffix inner element has proper flex alignment

The implementation ensures stable icon positioning by:

  • Using consistent margins on both sides
  • Proper flex alignment with display: inline-flex and align-items: center
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check how the new margin variable is applied and if there are any related layout styles that might affect icon stability

# Search for the old variable name to ensure complete migration
rg --type=less "tv-Dropdown-icon-margin-left"

# Check usage of the new variable and surrounding layout styles
rg --type=less -A 5 "tv-Dropdown-icon-margin-x"

# Look for other potential layout-affecting styles
ast-grep --pattern 'tiny-dropdown__suffix-inner {
  $$$
}'

Length of output: 1418

packages/theme/src/dropdown/index.less (2)

30-42: LGTM! These changes effectively fix the icon shaking issue.

The modifications address the icon shaking by:

  1. Using inline-flex with align-items: center ensures stable vertical alignment
  2. Consistent margin handling through the new inner wrapper classes prevents layout shifts

79-79: Verify button group layout changes across different scenarios.

The change from display: block to display: inline-flex aligns well with the flex-based approach. However, please verify this change doesn't affect existing button group layouts.

✅ Verification successful

Change from display: block to display: inline-flex is safe to proceed

The verification shows this change is safe because:

  1. The main button-group component already uses display: inline-block in its base styles (packages/theme/src/button-group/index.less)
  2. Only the SAAS theme has an explicit display: block override (packages/theme-saas/src/dropdown/index.less), but this is a separate theme package
  3. No visual regression tests indicate layout-specific issues with button groups
  4. The change aligns with the component's existing inline display behavior
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any custom overrides or dependencies on block display
rg -l "\.tiny-button-group\s*{[^}]*display:\s*block" --type less

# Search for potential layout issues in test files
rg -l "button-group.*layout" --type spec

Length of output: 408


Script:

#!/bin/bash
# Search for any custom overrides or dependencies on block display
rg -l "\.tiny-button-group.*display:\s*block"

# Search for button group related test files
rg -l "ButtonGroup.*test"

# Check for any existing button group styles
rg "button-group" --type less -A 3 -B 3

# Look for any visual regression tests
fd -e spec.ts -e spec.tsx -e test.ts -e test.tsx | xargs rg "ButtonGroup"

Length of output: 8946

@zzcr zzcr merged commit b688a3d into opentiny:dev Nov 26, 2024
10 of 14 checks passed
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