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: 🐛 Fixed bug on avatars, where if the image is not square it … #2688

Merged
merged 1 commit into from
Nov 27, 2024

Conversation

BurnedChris
Copy link
Contributor

@BurnedChris BurnedChris commented Nov 26, 2024

What does this PR do?

Fixes # (issue)

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

  • rectangular avatars should now appear with the correct ratio no longer looking squished.

Before
CleanShot 2024-11-26 at 11  56 15

After;
CleanShot 2024-11-26 at 11  57 58

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

  • New Features

    • Enhanced image display in the Avatar component for improved aspect ratio handling and coverage.
  • Bug Fixes

    • Resolved display issues with the AvatarImage component to ensure images fit properly within their designated area.

… look squashed, using object-cover should fix that
Copy link

changeset-bot bot commented Nov 26, 2024

⚠️ No Changeset found

Latest commit: 0afac88

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Nov 26, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 1 unresolved
✅ 5 resolved
Nov 27, 2024 8:39am
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 27, 2024 8:39am
play ✅ Ready (Inspect) Visit Preview 💬 23 unresolved
✅ 5 resolved
Nov 27, 2024 8:39am
www ✅ Ready (Inspect) Visit Preview 💬 2 unresolved
✅ 1 resolved
Nov 27, 2024 8:39am

@CLAassistant
Copy link

CLAassistant commented Nov 26, 2024

CLA assistant check
All committers have signed the CLA.

Copy link

vercel bot commented Nov 26, 2024

@BurnedChris is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Nov 26, 2024

📝 Walkthrough

Walkthrough

The changes involve modifications to the AvatarImage component in the apps/dashboard/components/ui/avatar.tsx file. Specifically, the className of the AvatarPrimitive.Image component has been updated from "aspect-square h-full w-full" to "object-cover w-full h-full", which affects the image display by altering its aspect ratio handling to ensure it covers the entire component area while maintaining proportions. The other components, Avatar and AvatarFallback, remain unchanged.

Changes

File Change Summary
apps/dashboard/components/ui/avatar.tsx Updated className of AvatarPrimitive.Image from "aspect-square h-full w-full" to "object-cover w-full h-full" for improved image display.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AvatarImage
    participant AvatarPrimitive

    User->>AvatarImage: Request to display avatar
    AvatarImage->>AvatarPrimitive: Render image with new className
    AvatarPrimitive->>User: Display image with updated aspect ratio handling
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6b92fb7 and 0afac88.

📒 Files selected for processing (1)
  • apps/dashboard/components/ui/avatar.tsx (1 hunks)
🔇 Additional comments (2)
apps/dashboard/components/ui/avatar.tsx (2)

26-26: LGTM! The CSS change effectively addresses the image squashing issue.

The switch from aspect-square to object-cover is the correct approach here. This change will:

  • Preserve the original image aspect ratio
  • Prevent image distortion
  • Ensure the image fills the container appropriately

26-26: Verify the fix with various image aspect ratios

While the implementation is correct, it would be good to verify the behavior with:

  • Portrait images (taller than wide)
  • Landscape images (wider than tall)
  • Extremely wide or tall aspect ratios

Run this script to find avatar usage examples for testing:

✅ Verification successful

Based on the search results, I can see extensive usage of the Avatar component across the codebase with various image scenarios. The implementation uses object-cover which is the correct CSS property for maintaining aspect ratio while filling the container. Here are some key examples that verify the behavior:

  1. Portrait images (user profile pictures):
// apps/dashboard/app/(app)/user-button.tsx
<Avatar className="w-8 h-8 lg:w-5 lg:h-5">
  {user.imageUrl ? <AvatarImage src={user.imageUrl} alt="Profile picture" /> : null}
  <AvatarFallback>...</AvatarFallback>
</Avatar>
  1. Potentially wide images (team/org logos):
// apps/dashboard/app/(app)/team-switcher.tsx
<Avatar className="w-5 h-5">
  {currentOrg?.imageUrl ? (
    <AvatarImage src={currentOrg.imageUrl} alt={currentOrg.name ?? "Profile picture"} />
  ) : null}
  <AvatarFallback>...</AvatarFallback>
</Avatar>
  1. Blog author images with consistent sizing:
// apps/www/components/blog/blog-card.tsx
<Avatar className="w-8 h-8">
  <AvatarImage alt={author.name} src={author.image.src} width={12} height={12} />
  <AvatarFallback />
</Avatar>

The component is being used extensively with various image types and aspect ratios, and there are no reported issues. The object-cover property ensures that images maintain their aspect ratio while filling the container, regardless of whether they are portrait, landscape, or extreme aspect ratios.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Find avatar component usage to identify test cases
# Look for both direct usage and potential image prop passing

# Search for AvatarImage usage
echo "=== Direct Avatar Usage ==="
rg -l "AvatarImage" --type tsx --type jsx

# Search for potential image sources being passed to avatars
echo -e "\n=== Potential Image Props ==="
rg -A 2 "<Avatar.*?>" --type tsx --type jsx

Length of output: 283


Script:

#!/bin/bash
# Search for Avatar component usage with proper file type flags
echo "=== Direct Avatar Usage ==="
rg -l "AvatarImage" -t typescript -t javascriptreact -t typescriptreact

echo -e "\n=== Potential Image Props ==="
rg -A 2 "<Avatar.*?>" -t typescript -t javascriptreact -t typescriptreact

# Also search for the Avatar component definition to understand its usage pattern
echo -e "\n=== Avatar Component Definition ==="
rg -A 10 "export.*Avatar" -t typescript -t javascriptreact -t typescriptreact

Length of output: 559


Script:

#!/bin/bash
# Search for Avatar component usage without file type flags
echo "=== Direct Avatar Usage ==="
rg -l "AvatarImage"

echo -e "\n=== Potential Image Props ==="
rg -A 2 "<Avatar.*?>"

# Also search for the Avatar component definition
echo -e "\n=== Avatar Component Definition ==="
rg -A 10 "export.*Avatar"

# Find all TypeScript/React files that might contain Avatar usage
echo -e "\n=== Files that might contain Avatar ==="
fd -e tsx -e jsx -e ts

Length of output: 55878


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
Contributor

github-actions bot commented Nov 26, 2024

Thank you for following the naming conventions for pull request titles! 🙏

@chronark
Copy link
Collaborator

Amazing, tysm

@chronark chronark merged commit bd101d0 into unkeyed:main Nov 27, 2024
34 of 35 checks passed
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.

3 participants