Avatar data api support

[GoldGroove06]

Summary by CodeRabbit

• New Features
  • Enhanced the Avatar component with new optional customizations for variant and size to improve appearance control.
• Tests
  • Added test cases to verify that the component correctly applies the new customization settings.

[coderabbitai]

Walkthrough

The changes update the Avatar component by adding two optional properties, variant and size, with default values. These properties are used in conjunction with the new hooks useCreateDataAttribute and useComposeAttributes to generate and pass data attributes to the AvatarPrimitive.Root. Additionally, the test suite has been expanded with two new cases to verify that the correct data attributes are applied based on the variant and size props.

Changes

File(s)	Change Summary
src/.../Avatar.tsx	Added variant and size optional properties to AvatarProps with default values. Integrated useCreateDataAttribute and useComposeAttributes hooks to generate and pass data attributes to the AvatarPrimitive.Root component.
src/.../Avatar.test.tsx	Added two new test cases to ensure the Avatar component correctly applies the data-avatar-variant and data-avatar-size attributes when the corresponding props are provided.

Sequence Diagram(s)

sequenceDiagram
    participant A as Avatar Component
    participant H1 as useCreateDataAttribute
    participant H2 as useComposeAttributes
    participant AP as AvatarPrimitive.Root

    A->>H1: Generate data attributes (variant, size, color)
    H1-->>A: Return individual data attribute objects
    A->>H2: Compose attributes from individual attributes
    H2-->>A: Return composedAttributes object
    A->>AP: Spread composedAttributes into component

Loading

Possibly related PRs

• Avatar and AvatarGroup with color support for fallback #793: Enhances the Avatar component by introducing a new color property, aligning with the context of extending component attributes.

Suggested labels

automerge

Suggested reviewers

• kotAPI

Poem

In the code field I hop with glee,
New props arrive—variant and size for me!
Attributes compose with a gentle touch,
Data flows smoothly—oh, so much!
I'm just a rabbit, celebrating this spree 🐰💻!

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

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 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: 0

🧹 Nitpick comments (1)

src/components/ui/Avatar/tests/Avatar.test.tsx (1)

30-34: Test for size attribute is well implemented, but has a minor spacing issue.

There should be a space between "RU" and size='small' for better readability.

-        render(<Avatar fallback="RU"size='small'/>);
+        render(<Avatar fallback="RU" size='small'/>);

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 13d2485 and 3f5bddf.

📒 Files selected for processing (2)

• src/components/ui/Avatar/Avatar.tsx (2 hunks)
• src/components/ui/Avatar/tests/Avatar.test.tsx (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build

🔇 Additional comments (5)

src/components/ui/Avatar/tests/Avatar.test.tsx (1)

24-28: Test case for avatar variant looks good!

This test effectively verifies that the variant prop is properly converted to a data attribute, which will be useful for styling different avatar variations.

src/components/ui/Avatar/Avatar.tsx (4)

4-4: Good addition of data attribute hooks.

Importing these hooks provides a clean way to handle data attributes for styling and customization.

---

13-14: Props for variant and size added correctly.

These optional props allow for more customization of the Avatar component without breaking existing usage.

---

21-25: Well implemented data attribute generation.

The approach of composing multiple data attributes is clean and maintainable. The default empty string values for the new props ensure backward compatibility.

Some considerations for future iterations:

• You might want to add validation for specific allowed variant/size values
• Documentation for available variants and sizes would be helpful for other developers

---

26-26: Good spread of composed attributes.

Spreading the composed attributes to the Root component ensures all data attributes are properly applied.