fix(user): avatar icon not shown in user #3371

abhinandan-verma · 2024-06-30T08:38:19Z

Closes #3369

📝 Description

Fixed the bug to show the default avatar icon, when no name(prop) is passed inside avatarProps

⛳️ Current behavior (updates)

🚀 New behavior

💣 Is this a breaking change (Yes/No):

No

📝 Additional Information

removed the code passing name(of user) to avatarProps

Summary by CodeRabbit

Bug Fixes
- Updated user avatar handling to ensure the correct name is passed only when no avatar icon is provided.
Tests
- Improved existing tests for avatar component and added a new test to verify the default icon is rendered when no name is provided.

changeset-bot · 2024-06-30T08:38:22Z

🦋 Changeset detected

Latest commit: 90c4bdc

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@nextui-org/user	Patch
@nextui-org/react	Patch

Not sure what this means? Click here to learn what changesets are.

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

vercel · 2024-06-30T08:38:23Z

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

Name	Status	Preview	Comments	Updated (UTC)
nextui-storybook-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 1, 2024 8:31am

vercel · 2024-06-30T08:38:24Z

@abhinandan-verma is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

coderabbitai · 2024-06-30T08:38:24Z

Walkthrough

The changes resolve a bug where the User component incorrectly rendered the avatar initial even when an avatar icon was provided. The fix involves updating the useUser function to stop passing the name property to the avatarProps when an avatar icon is used. Additionally, new tests are added to ensure the correct behavior by importing AvatarIcon and using it in the test cases.

Changes

Files	Change Summary
`packages/components/user/src/...`	Removed `name` property from `avatarProps` if the type is not a string.
`packages/components/user/__tests__/...`	Added import statement for `AvatarIcon`; modified test case; added new test.

Sequence Diagram(s)

Not applicable as the changes are mainly bug fixes and internal adjustments rather than new features or significant modifications to control flow.

Assessment against linked issues

Objective (Issue #)	Addressed	Explanation
Update `useUser` to stop passing `name` to `avatarProps` when `avatar icon` is provided (#3369)	✅
Ensure default avatar icon renders correctly (#3369)	✅

Tip

Early access features: enabled

We are currently testing the following features in early access:

OpenAI gpt-4o model for code reviews and chat: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available.

Note:

You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
Please join our Discord Community to provide feedback and report issues.
OSS projects are currently opted into early access features by default.

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

Outside diff range and nitpick comments (2)

packages/components/user/src/use-user.ts (2)
Line range hint 1-2: Unused Imports

The useUser function no longer uses the SlotsToClasses and UserSlots imports. Consider removing them.
-import type {SlotsToClasses, UserSlots} from "@nextui-org/theme";
+import type {AvatarProps} from "@nextui-org/avatar";
Line range hint 3-3: Import Optimization

The AvatarProps import is used and should be retained.
-import type {AvatarProps} from "@nextui-org/avatar";
+import type {AvatarProps} from "@nextui-org/avatar";

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9daef56 and e6ea208.

Files selected for processing (1)

packages/components/user/src/use-user.ts (1 hunks)

Additional comments not posted (1)

packages/components/user/src/use-user.ts (1)

Line range hint 32-32: Remove Unused name Property

The name property assignment in avatarProps has been removed, which aligns with the PR objective to ensure the default avatar icon is shown when no name is passed. This change addresses the issue correctly.

.changeset/few-stingrays-lay.md

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e6ea208 and ac5d9b6.

Files selected for processing (1)

.changeset/few-stingrays-lay.md (1 hunks)

Files skipped from review due to trivial changes (1)

.changeset/few-stingrays-lay.md

wingkwong

a test case is missing. please add one to cover the reported case.

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ac5d9b6 and 7824fd7.

Files selected for processing (3)

.changeset/nice-penguins-work.md (1 hunks)
.changeset/ten-donuts-tease.md (1 hunks)
packages/components/user/tests/user.test.tsx (2 hunks)

Files not reviewed due to errors (1)

packages/components/user/tests/user.test.tsx (no review received)

Files skipped from review due to trivial changes (1)

.changeset/nice-penguins-work.md

Additional comments not posted (1)

.changeset/ten-donuts-tease.md (1)

1-5: Changeset description is accurate.

The changeset correctly describes the removal of the name attribute from avatarProps in use-user.ts as per the PR objectives.

wingkwong · 2024-06-30T11:15:21Z

packages/components/user/__tests__/user.test.tsx

+  it("should render the default icon if no name passed to avatar", () => {
+    const {queryByTestId} = render(
+      <User
+        avatarProps={{
+          radius: "full",
+          size: "sm",
+          icon: <AvatarIcon />,
+          classNames: {
+            base: "bg-gradient-to-br from-[#FFB457] to-[#FF705B]",
+            icon: "text-black/80",
+          },
+          name: "avatar-icon",
+        }}
+        name="Test"
+      />,
+    );
+
+    expect(queryByTestId("avatar-icon")).toBeNull();


this test case doesn't match with the title. also the issue is that the attribute name in User component got forwarded to Avatar component. in your test case, it shouldn't have name in avatarProps.

Ok, I Will try again to make it perfect.

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7824fd7 and 90c4bdc.

Files selected for processing (2)

.changeset/fair-zebras-fetch.md (1 hunks)
packages/components/user/tests/user.test.tsx (1 hunks)

Files skipped from review as they are similar to previous changes (1)

packages/components/user/tests/user.test.tsx

Additional comments not posted (1)

.changeset/fair-zebras-fetch.md (1)

1-5: Changeset is accurate and complete.

The changeset correctly documents the removal of the name property from avatarProps in use-user.ts.

wingkwong

previous comment hasn't been resolved. besides, the test for this issue is missing.

abhinandan-verma added 2 commits June 30, 2024 13:46

fix(user): avatar icon not shown in user component

af37f80

fix(user): avatar icon not shown in user component

e6ea208

abhinandan-verma requested a review from jrgarciadev as a code owner June 30, 2024 08:38

coderabbitai bot reviewed Jun 30, 2024

View reviewed changes

vercel bot deployed to Preview – nextui-storybook-v2 June 30, 2024 08:40 View deployment

fix(user): avatar icon not shown in user component

ac5d9b6

wingkwong requested changes Jun 30, 2024

View reviewed changes

.changeset/few-stingrays-lay.md Outdated Show resolved Hide resolved

.changeset/few-stingrays-lay.md Outdated Show resolved Hide resolved

coderabbitai bot reviewed Jun 30, 2024

View reviewed changes

vercel bot deployed to Preview – nextui-storybook-v2 June 30, 2024 08:50 View deployment

fix(user): avatar icon not shown in user component

a49d8e3

abhinandan-verma requested a review from wingkwong June 30, 2024 08:55

vercel bot deployed to Preview – nextui-storybook-v2 June 30, 2024 08:58 View deployment

Delete .changeset/few-stingrays-lay.md

fce1018

vercel bot deployed to Preview – nextui-storybook-v2 June 30, 2024 09:02 View deployment

wingkwong requested changes Jun 30, 2024

View reviewed changes

fix(user): avatar icon not shown in user component

7824fd7

coderabbitai bot reviewed Jun 30, 2024

View reviewed changes

vercel bot deployed to Preview – nextui-storybook-v2 June 30, 2024 09:50 View deployment

abhinandan-verma requested a review from wingkwong June 30, 2024 10:55

wingkwong requested changes Jun 30, 2024

View reviewed changes

abhinandan-verma added 2 commits July 1, 2024 13:55

fix(user): avatar icon not shown in user component

da2cbb7

fix(user): avatar icon not shown in user component

90c4bdc

abhinandan-verma requested a review from wingkwong July 1, 2024 08:27

coderabbitai bot reviewed Jul 1, 2024

View reviewed changes

vercel bot deployed to Preview – nextui-storybook-v2 July 1, 2024 08:31 View deployment

wingkwong requested changes Jul 1, 2024

View reviewed changes

wingkwong added the 🚧 Status: Changes Requested label Jul 1, 2024

abhinandan-verma closed this Jul 1, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(user): avatar icon not shown in user #3371

fix(user): avatar icon not shown in user #3371

abhinandan-verma commented Jun 30, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Jun 30, 2024 •

edited

Loading

vercel bot commented Jun 30, 2024 •

edited

Loading

vercel bot commented Jun 30, 2024

coderabbitai bot commented Jun 30, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot left a comment

wingkwong left a comment

coderabbitai bot left a comment

wingkwong Jun 30, 2024 •

edited

Loading

abhinandan-verma Jun 30, 2024

coderabbitai bot left a comment

wingkwong left a comment

fix(user): avatar icon not shown in user #3371

fix(user): avatar icon not shown in user #3371

Conversation

abhinandan-verma commented Jun 30, 2024 • edited by coderabbitai bot Loading

📝 Description

⛳️ Current behavior (updates)

🚀 New behavior

💣 Is this a breaking change (Yes/No):

📝 Additional Information

Summary by CodeRabbit

changeset-bot bot commented Jun 30, 2024 • edited Loading

🦋 Changeset detected

vercel bot commented Jun 30, 2024 • edited Loading

vercel bot commented Jun 30, 2024

coderabbitai bot commented Jun 30, 2024 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

wingkwong left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

wingkwong Jun 30, 2024 • edited Loading

Choose a reason for hiding this comment

abhinandan-verma Jun 30, 2024

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

wingkwong left a comment

Choose a reason for hiding this comment

abhinandan-verma commented Jun 30, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Jun 30, 2024 •

edited

Loading

vercel bot commented Jun 30, 2024 •

edited

Loading

coderabbitai bot commented Jun 30, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

wingkwong Jun 30, 2024 •

edited

Loading