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: background color visibility on dropdown hover #3330 #3340

Conversation

yashsaraswat2004
Copy link

@yashsaraswat2004 yashsaraswat2004 commented Oct 28, 2024

This PR fixes an issue with the visibility of background colors on components in the dropdown menu when hovering. Previously, hovering over dropdown items within the Docs, Community, and Tools menus did not display the intended background color, causing a poor user experience.

To address this:

Updated the background color styling to improve contrast and visibility for dropdown items on hover.
Verified that changes are consistent across different dropdown menus for a cohesive look.
Screenshots

Screenshot (93)

How to Test

Open the ASyncAPI website in Google Chrome.
Hover over Docs, Community, or Tools in the navigation bar to trigger the dropdown menu.
Move the cursor over items in the dropdown menu to see the hover effect.
Related Issue(s)

Fixes #3330

Summary by CodeRabbit

  • Style
    • Updated hover effect for menu block links to provide a more pronounced visual feedback.

Copy link

coderabbitai bot commented Oct 28, 2024

Walkthrough

The changes made in this pull request involve a modification to the hover state CSS class for menu block links in the MenuBlocks component. The hover class has been updated from hover:bg-gray-50 to hover:bg-gray-300, enhancing the visual feedback for users when they hover over menu items. No other logic or functionality within the component has been altered.

Changes

File Change Summary
components/navigation/MenuBlocks.tsx Updated hover class from hover:bg-gray-50 to hover:bg-gray-300 for menu block links.

Assessment against linked issues

Objective Addressed Explanation
Background Color should be visible on hovering in the dropdown menu (3330)

🐇 In the menu, the colors now play,
Hovering brings a brighter day!
From gray-50 to gray-300, so fine,
A change in hue, oh how it shines!
With each click and every glance,
The dropdown dances, a joyful chance! 🌈


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.

Copy link

netlify bot commented Oct 28, 2024

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit eca8f60
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/671fb332f01465000826ce1c
😎 Deploy Preview https://deploy-preview-3340--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@yashsaraswat2004 yashsaraswat2004 changed the title fix: Background color visibility on dropdown hover #3330 fix: background color visibility on dropdown hover #3330 Oct 28, 2024
@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Oct 28, 2024

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 45
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

Lighthouse ran on https://deploy-preview-3340--asyncapi-website.netlify.app/

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

🧹 Outside diff range and nitpick comments (1)
components/navigation/MenuBlocks.tsx (1)

46-46: Add transition for smoother hover effect.

While the hover color change improves visibility, the component could benefit from a smoother transition.

The component already has transition duration-150 ease-in-out, but consider explicitly adding background-color to the transition properties:

-              className={`-m-3 flex items-start space-x-4 rounded-lg p-3 transition duration-150 ease-in-out ${
+              className={`-m-3 flex items-start space-x-4 rounded-lg p-3 transition-all transition-colors duration-150 ease-in-out ${
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d7ee919 and eca8f60.

📒 Files selected for processing (1)
  • components/navigation/MenuBlocks.tsx (1 hunks)
🔇 Additional comments (2)
components/navigation/MenuBlocks.tsx (2)

46-46: Changes successfully address the visibility issue.

The modification from hover:bg-gray-50 to hover:bg-gray-300 effectively resolves the background color visibility issue mentioned in #3330. The increased contrast provides better visual feedback during hover interactions.


46-46: Verify color contrast meets accessibility standards.

The change from hover:bg-gray-50 to hover:bg-gray-300 improves visibility, but we should ensure it meets WCAG contrast requirements for hover states.

Consider using the following tools to verify the contrast:

  1. Check if the color is part of your design system's approved palette
  2. Verify contrast ratios using a tool like WebAIM's contrast checker
  3. Test with different color modes (light/dark) if applicable
✅ Verification successful

The hover color change is consistent with the design system and accessibility patterns

The change to hover:bg-gray-300 is verified to be appropriate because:

  • It's already used consistently across multiple components in the codebase for interactive elements (Label, DocsNav, Button)
  • The color provides sufficient contrast as it's used in other prominent UI elements like buttons and labels where visibility is crucial
  • It maintains consistency with the existing color system, as seen in the codebase's usage patterns
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other uses of bg-gray-300 to ensure consistency
rg "bg-gray-300" --type tsx --type jsx

Length of output: 66


Script:

#!/bin/bash
# Search for bg-gray-300 usage across all files (without file type restriction)
rg "bg-gray-300"

# Search for other background color classes to understand the color system
rg "bg-gray-[0-9]+"

# Look for any Tailwind config files that might define these colors
fd "tailwind.config" --type f

Length of output: 16402

@@ -43,7 +43,7 @@ export default function MenuBlocks({ items = [] }: MenuBlocksProps) {
<span
data-testid='MenuBlocks-Link'
className={`-m-3 flex items-start space-x-4 rounded-lg p-3 transition duration-150 ease-in-out ${
router.asPath === item.href ? 'bg-secondary-100 shadow-sm' : 'hover:bg-gray-50'
router.asPath === item.href ? 'bg-secondary-100 shadow-sm' : 'hover:bg-gray-300'
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider active/hover state distinction.

The current implementation uses bg-secondary-100 for active (selected) items and hover:bg-gray-300 for hover. These states should be visually distinct but related.

Consider using a consistent color family:

-                router.asPath === item.href ? 'bg-secondary-100 shadow-sm' : 'hover:bg-gray-300'
+                router.asPath === item.href ? 'bg-secondary-100 shadow-sm' : 'hover:bg-secondary-50'
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
router.asPath === item.href ? 'bg-secondary-100 shadow-sm' : 'hover:bg-gray-300'
router.asPath === item.href ? 'bg-secondary-100 shadow-sm' : 'hover:bg-secondary-50'

Copy link

codecov bot commented Oct 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 49.14%. Comparing base (d7ee919) to head (eca8f60).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3340   +/-   ##
=======================================
  Coverage   49.14%   49.14%           
=======================================
  Files          21       21           
  Lines         647      647           
=======================================
  Hits          318      318           
  Misses        329      329           

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

@anshgoyalevil
Copy link
Member

The previous color seems relevant too. Why we need more intense color on hover?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] Background color of components in the dropdown menu is not visible properly on hovering
3 participants