feat: added user avatar.

[Sahil2004]

Description of change

[Continues #127]

Added all the 4 variants of the user avatar as in the design:

• xs: 24px
• sm: 40px
• md: 48px (default)
• lg: 120px

Story made.

Issue Number

Closes #123

Type of change

• New (a change which implements a new feature)

How the change has been tested

Through storybook.

Change checklist

• I have ensured that the CI Checks pass locally
• I have removed any unnecessary logic
• My code is well documented
• I have signed my commits
• My code follows the pattern of the application
• I have self reviewed my code

Summary by CodeRabbit

• New Features

  • Introduced a new Avatar component for displaying user profile images with customizable sizes.
  • Added Storybook examples showcasing the Avatar component in various sizes for easier preview and testing.

• Chores

  • Made the Avatar component available for import throughout the application.

[coderabbitai]

Walkthrough

A new extensible Svelte Avatar component was introduced, supporting size variants (xs, sm, md, lg) and accessibility features. Storybook stories were added to showcase each size variant. The component and its stories were exported through the module index for broader use in the UI library.

Changes

File(s)	Change Summary
platforms/metagram/src/lib/ui/Avatar/Avatar.svelte	New Svelte Avatar component created with props for src, alt, and size ("xs", "sm", "md", "lg").
platforms/metagram/src/lib/ui/Avatar/Avatar.stories.ts	New Storybook stories file added, demonstrating Avatar variants for each size using a sample image.
platforms/metagram/src/lib/ui/index.ts	Added export for Avatar component; updated export style for Button.

Sequence Diagram(s)

sequenceDiagram
    participant Storybook
    participant AvatarStory
    participant AvatarComponent

    Storybook->>AvatarStory: Render story (e.g., Large)
    AvatarStory->>AvatarComponent: Render with props (src, size)
    AvatarComponent-->>AvatarStory: Displays avatar image with correct size
    AvatarStory-->>Storybook: Shows rendered avatar variant

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Implement extensible Avatar component with variants (xs, sm, md, lg) and pre-applied classes (#123)	✅
Name variants according to Tailwind nomenclature and provide Storybook stories (#123)	✅
Ensure extensibility and align with expectations from reference (#123)	✅

Poem

A fluffy new friend in the code appears,
With avatars sized from small to big ears!
Storybook shows off each rounded face,
In "xs" to "lg", they all find their place.
Hop, hop, hooray—new avatars to see,
The UI garden grows, as happy as can be!
🐰✨

Tip

⚡️ Faster reviews with caching

• CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (4)

platforms/metagram/src/lib/ui/Avatar/Avatar.svelte (2)

31-36: Improve class composition with cn utility

The class composition could be simplified. The current implementation applies cn() to an already joined string, which is redundant.

-	class={cn([classes.common, classes.size, restProps.class].join(' '))}
+	class={cn(classes.common, classes.size, restProps.class)}

---

1-37: Consider adding fallback UI for loading or error states

The avatar component has no handling for image loading failures. Consider adding:

1. A fallback UI when the image fails to load (initials, placeholder icon)
2. Loading state feedback

Here's an example implementation using Svelte's onError handler:

<script lang="ts">
import { cn } from "$lib/utils";
import type { HTMLImgAttributes } from "svelte/elements";

interface IAvatarProps extends HTMLImgAttributes {
    src: string;
    alt?: string;
    size?: "xs" | "sm" | "md" | "lg";
+    initials?: string;
}

const {
    src,
    alt = "User Avatar",
    size = "md",
+    initials,
    ...restProps
}: IAvatarProps = $props();

const sizeVariant = {
    xs: "w-6 h-6",
    sm: "w-10 h-10",
    md: "w-12 h-12",
    lg: "w-30 h-30",
};

const classes = $derived({
    common: cn("rounded-full"),
    size: sizeVariant[size] || sizeVariant.md,
});

+let hasError = false;
+
+function handleError() {
+    hasError = true;
+}
</script>

+{#if hasError && initials}
+<div 
+    class={cn(classes.common, classes.size, "bg-gray-200 flex items-center justify-center text-gray-600", restProps.class)} 
+    {...restProps}
+>
+    <span class={size === "xs" ? "text-xs" : size === "sm" ? "text-sm" : size === "lg" ? "text-xl" : "text-base"}>
+        {initials}
+    </span>
+</div>
+{:else if hasError}
+<div 
+    class={cn(classes.common, classes.size, "bg-gray-200 flex items-center justify-center", restProps.class)} 
+    {...restProps}
+>
+    <!-- Default placeholder icon could go here -->
+</div>
+{:else}
<img
	{...restProps}
	{src}
	{alt}
	class={cn(classes.common, classes.size, restProps.class)}
+	on:error={handleError}
/>
+{/if}

platforms/metagram/src/lib/ui/Avatar/Avatar.stories.ts (2)

17-43: Expand story variants to demonstrate error handling and additional props

The current stories are good for demonstrating size variants, but consider adding:

1. A story demonstrating invalid image URL handling
2. A story showing usage with additional HTML attributes (e.g., role, data-testid)

export const WithInvalidSource = {
    args: {
        src: "https://example.com/invalid-image.jpg",
        size: "md",
    },
};

export const WithAdditionalAttributes = {
    args: {
        src: "https://www.gravatar.com/avatar/2c7d99fe281ecd3bcd65ab915bac6dd5?s=250",
        size: "md",
        "data-testid": "user-avatar",
        role: "img",
    },
};

---

4-15: Consider adding control knobs for interactive testing

The current Storybook setup is good, but you could enhance it by adding control knobs for more interactive testing.

export default {
    title: "UI/Avatar",
    component: Avatar,
    tags: ["autodocs"],
+   argTypes: {
+       size: {
+           control: { type: 'select' },
+           options: ['xs', 'sm', 'md', 'lg'],
+           defaultValue: 'md',
+       },
+       src: { control: 'text' },
+       alt: { control: 'text' },
+   },
    render: (args: {
        Component: Avatar;
        props: ComponentProps<typeof Avatar>;
    }) => ({
        Component: Avatar,
        props: args,
    }),
};

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3ad2c15 and 9b9e097.

📒 Files selected for processing (3)

• platforms/metagram/src/lib/ui/Avatar/Avatar.stories.ts (1 hunks)
• platforms/metagram/src/lib/ui/Avatar/Avatar.svelte (1 hunks)
• platforms/metagram/src/lib/ui/index.ts (1 hunks)

🔇 Additional comments (1)

platforms/metagram/src/lib/ui/index.ts (1)

1-2: LGTM! Clean export pattern

The export for the Avatar component follows the existing pattern in the codebase.

[coderabbitai]

💡 Verification agent

🧩 Analysis chain

Verify Tailwind class compatibility for large size variant

The large size variant uses w-30 h-30 classes, but standard Tailwind CSS typically only includes classes up to w-24/h-24 (96px). Ensure these classes are properly defined in your Tailwind configuration, or consider using standard classes like w-[120px] h-[120px] instead.

---

🏁 Script executed:

#!/bin/bash
# Check if w-30 and h-30 are defined in the Tailwind config
grep -r "w-30\|h-30" platforms/metagram/tailwind.config.*

Length of output: 131

---

🏁 Script executed:

#!/bin/bash
# Locate Tailwind config files across the repo
configs=$(find . -maxdepth 4 -type f -iname "tailwind.config.*")
echo "Configs found:"
echo "$configs"

for cfg in $configs; do
  echo
  echo "---- Inspecting $cfg ----"
  echo "Checking for custom spacing definitions:"
  grep -R "spacing" -n "$cfg" || echo "  No 'spacing' key found in $cfg"
  echo
  echo "Looking for a '30' spacing entry (e.g., 30: '7.5rem'):"
  grep -R "30\s*:" -n "$cfg" || echo "  No '30:' entry found under spacing in $cfg"
done

if [ -z "$configs" ]; then
  echo "No Tailwind config file detected in the repository."
fi

Length of output: 246

---

Add custom spacing for 30 or switch to arbitrary values

Tailwind’s default spacing scale doesn’t include a 30 key, and no tailwind.config.* was detected in the repo, so w-30 h-30 won’t be generated out of the box. You can either:

• Extend the spacing scale in your Tailwind config (create one at the repo root if needed):

// tailwind.config.js
module.exports = {
  theme: {
    extend: {
      spacing: {
        30: '7.5rem', // 120px
      },
    },
  },
};

• Or use arbitrary values directly in the component:

--- platforms/metagram/src/lib/ui/Avatar/Avatar.svelte
@@ const sizeVariant = {
-   lg: "w-30 h-30",
+   lg: "w-[120px] h-[120px]",
};

Locations to update:

• platforms/metagram/src/lib/ui/Avatar/Avatar.svelte (lines 18–23)