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. #3337

Closed
wants to merge 6 commits into from

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 items to provide a more distinct visual feedback.
  • Chores

    • Enhanced type safety by specifying the type for a variable in the renderContent function.

Copy link

coderabbitai bot commented Oct 28, 2024

Walkthrough

The pull request includes two primary changes: a CSS class modification for the hover state of menu block items in the MenuBlocks component, changing from hover:bg-gray-50 to hover:bg-gray-300, enhancing the visibility of the hover effect. Additionally, in the renderContent function of the pages/casestudies/[id].tsx file, a type annotation for the typeStyle variable has been added to improve type safety, specifying it as HeadingTypeStyle. No other functional changes or alterations to exported entities were made.

Changes

File Change Summary
components/navigation/MenuBlocks.tsx Changed hover class from hover:bg-gray-50 to hover:bg-gray-300.
pages/casestudies/[id].tsx Added type annotation : HeadingTypeStyle to typeStyle variable in renderContent.

Assessment against linked issues

Objective Addressed Explanation
Background Color should be visible on hovering (#[3330])

Possibly related PRs

Suggested labels

ready-to-merge, bounty

Suggested reviewers

  • derberg
  • magicmatatjahu
  • Mayaleeeee
  • asyncapi-bot-eve
  • devilkiller-ag
  • sambhavgupta0705
  • akshatnema

🐇 In the menu, a change so bright,
Hover now brings a joyful sight!
Type safety added with a cheer,
Making our code more clear, my dear!
With colors bright and types so right,
Let's hop along, it feels just right! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between bf093c2 and e3705eb.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (1)
  • pages/casestudies/[id].tsx (1 hunks)
🔇 Additional comments (1)
pages/casestudies/[id].tsx (1)

45-45: LGTM! Type annotation improves type safety.

The addition of the HeadingTypeStyle type annotation for the typeStyle variable enhances type safety and code maintainability.


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

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

Copy link

netlify bot commented Oct 28, 2024

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit e3705eb
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/671f6e41e74e940008b6a7cd
😎 Deploy Preview https://deploy-preview-3337--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
@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 44
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

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

@yashsaraswat2004 yashsaraswat2004 changed the title fix: Background color visibility on dropdown hover #3330. fix: background color visibility on dropdown hover #3330. Oct 28, 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 (1)
components/navigation/MenuBlocks.tsx (1)

Line range hint 29-41: Consider enhancing screen reader support.

While the hover state visibility is improved, consider these accessibility enhancements:

 <LinkComponent
   href={item.comingSoon ? '' : item.href}
   key={index}
   target={isExternalHref ? '_blank' : undefined}
   rel={isExternalHref ? 'noopener noreferrer' : undefined}
+  aria-label={`${item.title}${isExternalHref ? ' (opens in new tab)' : ''}`}
 >
   <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-300'
     }`}
   >
     <div
       className={`flex size-10 shrink-0 items-center justify-center rounded-lg ${
         item.className ? item.className : 'border border-gray-800 bg-secondary-100'
       } text-gray-900 sm:size-12 ${item.comingSoon && 'opacity-50'}`}
       data-testid='MenuBlock-icon'
+      aria-hidden="true"
     >
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7c27ab6 and bf093c2.

📒 Files selected for processing (3)
  • components/navigation/MenuBlocks.tsx (1 hunks)
  • components/navigation/NavMenu.tsx (1 hunks)
  • components/navigation/SubCategoryDocsNav.tsx (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • components/navigation/NavMenu.tsx
  • components/navigation/SubCategoryDocsNav.tsx
🔇 Additional comments (1)
components/navigation/MenuBlocks.tsx (1)

46-46: Improved hover state visibility with better contrast.

The change from hover:bg-gray-50 to hover:bg-gray-300 effectively addresses the visibility issue by providing better contrast during hover interactions.

Let's verify the contrast ratios meet WCAG guidelines:

✅ Verification successful

Hover state contrast change is appropriate and consistent with existing usage

The change to hover:bg-gray-300 is well-implemented:

  • It's used consistently with text colors that ensure good contrast (text-gray-700 and text-gray-800 in other components)
  • The hover state provides sufficient visual feedback while maintaining readability
  • The implementation preserves the existing conditional logic for active state styling
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any color-related accessibility issues in the codebase
# Look for potential contrast issues with gray-300 background
rg -i "text-\w+(?:-\d+)?\s+.*bg-gray-300|bg-gray-300\s+.*text-\w+(?:-\d+)?" 

Length of output: 393


Script:

#!/bin/bash
# Let's check the text colors used with the hover:bg-gray-300 class to ensure proper contrast
rg -A 2 -B 2 "hover:bg-gray-300"

# Also check if there are any existing color contrast guidelines or theme configurations
fd -e js -e ts -e json "theme|color" --exec grep -l -i "contrast\|accessibility\|gray-300"

Length of output: 595

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 (7c27ab6) to head (e3705eb).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3337   +/-   ##
=======================================
  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.

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
2 participants