Fix(user): avatar icon not shown in user, when passed #3370

awesome-pro · 2024-06-30T05:42:18Z

Closes #3369

📝 Description

Added name prop in avatarProps, changed name(of avatarProps) to be same as name(of User)

⛳️ Current behavior (updates)

🚀 New behavior

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

No

📝 Additional Information

Summary by CodeRabbit

New Features
- Footer now includes "All rights reserved." after the company name.
Refactor
- Modified test cases in User component for more accurate assertions.
Chores
- Updated various layout components to include new ScriptProviders. Removed ScriptProviders from the root layout component.
- Expanded useUser function to accept a name property.

…ch decendant folder

changeset-bot · 2024-06-30T05:42:21Z

⚠️ No Changeset found

Latest commit: 0fc9f53

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

vercel · 2024-06-30T05:42:22Z

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	Jun 30, 2024 6:01am

vercel · 2024-06-30T05:42:23Z

@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-30T05:43:12Z

Walkthrough

The changes focus on integrating the ScriptProviders component into specific layouts, enhancing the Footer with an additional text, and refining the User component test and useUser function. These modifications improve component functionality and fix a bug related to avatar handling in the User component.

Changes

Files	Change Summaries
`apps/docs/app/blog/layout.tsx` `apps/docs/app/docs/layout.tsx` `apps/docs/app/figma/page.tsx`	Added import and usage of `ScriptProviders` component.
`apps/docs/app/layout.tsx`	Removed import and usage of `ScriptProviders` component.
`apps/docs/components/footer.tsx`	Added “All rights reserved.” text to the footer.
`packages/components/user/__tests__/user.test.tsx`	Changed test case to use `getByText` instead of querying container directly for finding the name element.
`packages/components/user/src/use-user.ts`	Added `name` property to `avatarProps` in the `useUser` function, allowing it to accept a string or undefined value for the name.

Assessment against linked issues

Objective (Issue #3369)	Addressed	Explanation
Correct avatar icon display logic by allowing `name` to be passed through `avatarProps`	✅

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 always opted into early access features.

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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

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

Files selected for processing (7)

apps/docs/app/blog/layout.tsx (2 hunks)
apps/docs/app/docs/layout.tsx (2 hunks)
apps/docs/app/figma/page.tsx (2 hunks)
apps/docs/app/layout.tsx (2 hunks)
apps/docs/components/footer.tsx (1 hunks)
packages/components/user/tests/user.test.tsx (1 hunks)
packages/components/user/src/use-user.ts (2 hunks)

Files skipped from review due to trivial changes (2)

apps/docs/app/layout.tsx
apps/docs/components/footer.tsx

Additional comments not posted (4)

apps/docs/app/blog/layout.tsx (1)

3-4: Importing and using ScriptProviders.

The ScriptProviders component is correctly imported and used within the JSX structure.

apps/docs/app/docs/layout.tsx (1)

5-5: Importing and using ScriptProviders.

The ScriptProviders component is correctly imported and used within the JSX structure.

packages/components/user/__tests__/user.test.tsx (1)

22-25: Improving test readability and reliability.

Using getByText instead of querying the container directly improves the readability and reliability of the test.

apps/docs/app/figma/page.tsx (1)

5-5: Importing and using ScriptProviders.

The ScriptProviders component is correctly imported and used within the JSX structure.

packages/components/user/src/use-user.ts

wingkwong

Please include a changeset
Please exclude those unrelated files
The test case "should have the passed name" shouldn't be changed. Instead, you should add the new test case for the avatarProp case.

wingkwong · 2024-06-30T05:52:06Z

packages/components/user/src/use-user.ts

@@ -31,7 +31,7 @@ interface Props {
   * The user avatar props
   * @see https://nextui.org/docs/components/avatar
   */
-  avatarProps?: Partial<AvatarProps>;
+  avatarProps?: Partial<AvatarProps> & {name?: string | undefined};


name is in AvatarProps already. There's no need to add that again.

wingkwong and others added 3 commits June 29, 2024 17:46

chore(docs): update footer text (heroui-inc#3350)

996a0ed

fix(doc): migrated ScriptProvider component from the root level to ea…

69db63c

…ch decendant folder

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

2280c2a

awesome-pro requested a review from jrgarciadev as a code owner June 30, 2024 05:42

coderabbitai bot reviewed Jun 30, 2024

View reviewed changes

packages/components/user/src/use-user.ts Show resolved Hide resolved

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

wingkwong requested changes Jun 30, 2024

View reviewed changes

Merge branch 'nextui-org:canary' into fix/avatar-icon-not-shown-in-user

0fc9f53

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

awesome-pro closed this Jun 30, 2024

awesome-pro deleted the fix/avatar-icon-not-shown-in-user branch June 30, 2024 06:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix(user): avatar icon not shown in user, when passed #3370

Fix(user): avatar icon not shown in user, when passed #3370

awesome-pro 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

wingkwong left a comment

wingkwong Jun 30, 2024

Fix(user): avatar icon not shown in user, when passed #3370

Fix(user): avatar icon not shown in user, when passed #3370

Conversation

awesome-pro 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

⚠️ No Changeset found

vercel bot commented Jun 30, 2024 • edited Loading

vercel bot commented Jun 30, 2024

coderabbitai bot commented Jun 30, 2024 • edited Loading

Walkthrough

Changes

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

wingkwong left a comment

Choose a reason for hiding this comment

wingkwong Jun 30, 2024

Choose a reason for hiding this comment

awesome-pro 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`)