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: remove disableAnimation prop from span element instead of img el… #3593

Open
wants to merge 1 commit into
base: canary
Choose a base branch
from

Conversation

kuri-sun
Copy link
Contributor

@kuri-sun kuri-sun commented Aug 2, 2024

Closes #

Im working on this linear issue: https://linear.app/nextui-inc/issue/ENG-1225/react-doesnt-recognize-disableanimation

📝 Description

[Cause of the error]
The error says we need to remove disableAnimation prop from <span> element.

Screenshot 2024-08-02 at 11 36 31 PM

Currently we are trying to remove this prop from <img> element instead of <span>. So, I removed those lines of codes.
The cause of this error is we did not extract disabledAnimation prop in useAvatar function's argument object de-structuring so that we accidentally passed disableAnimation to <span> element with otherProps.

[Solution]
So, to avoid passing this prop to <span> element(which means we shall avoid including disableAnimation in otherProps), we added the object de-structuring as a solution for this.

⛳️ Current behavior (updates)

the error message in console

🚀 New behavior

Screenshot 2024-08-02 at 11 47 02 PM

Working as fine.

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

No

📝 Additional Information

Summary by CodeRabbit

  • Improvements
    • Enhanced the handling of animation properties for better clarity and performance.
    • Simplified the logic for managing the animation control within the avatar component, leading to improved maintainability.
    • Filtered DOM properties to exclude unnecessary complexity, potentially improving overall performance.

@kuri-sun kuri-sun added the 📦 Scope : Components Related to the components label Aug 2, 2024
@kuri-sun kuri-sun added this to the v2.5.0 milestone Aug 2, 2024
@kuri-sun kuri-sun self-assigned this Aug 2, 2024
Copy link

linear bot commented Aug 2, 2024

Copy link

vercel bot commented Aug 2, 2024

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

Name Status Preview Comments Updated (UTC)
nextui-docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 2, 2024 2:48pm
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 2, 2024 2:48pm

Copy link

changeset-bot bot commented Aug 2, 2024

⚠️ No Changeset found

Latest commit: ea89296

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
Contributor

coderabbitai bot commented Aug 2, 2024

Important

Review skipped

Auto reviews are limited to specific labels.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent changes to the use-avatar.ts file enhance the handling of the disableAnimation property by renaming it to isDisableAnimation for clarity and initializing it directly from the input props. This streamlining improves readability and reduces complexity in prop filtering by excluding disableAnimation from the DOM properties. Overall, these modifications aim to improve code maintainability and understanding of component behavior without altering the function's signature.

Changes

File Change Summary
packages/components/avatar/src/use-avatar.ts Simplified handling of disableAnimation, renamed to isDisableAnimation, and excluded from DOM props.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AvatarComponent
    participant useAvatar

    User->>AvatarComponent: Render Avatar
    AvatarComponent->>useAvatar: Call useAvatar(originalProps)
    useAvatar->>useAvatar: Initialize isDisableAnimation
    useAvatar->>AvatarComponent: Return props
    AvatarComponent->>DOM: Render with filtered props
Loading

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

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 6d9995b and ea89296.

Files selected for processing (1)
  • packages/components/avatar/src/use-avatar.ts (6 hunks)
Additional comments not posted (5)
packages/components/avatar/src/use-avatar.ts (5)

120-120: Initialization of disableAnimation property.

The disableAnimation property is correctly initialized with a default value of false and destructured from originalProps, ensuring it is not passed to the <span> element.


139-139: Assignment of isDisableAnimation variable.

The isDisableAnimation variable is correctly assigned the value of disableAnimation or the global context's disableAnimation if it exists, enhancing clarity and maintainability.


163-163: Usage of isDisableAnimation in slots object.

The disableAnimation property in the slots object is correctly updated to use isDisableAnimation, ensuring accurate component behavior.


172-172: Addition of isDisableAnimation to dependency array.

The isDisableAnimation variable is correctly added to the dependency array of the useMemo hook, ensuring proper reactivity of the component.


205-207: Merging of imgProps and props in getImageProps function.

The getImageProps function correctly merges imgProps and props, enhancing code maintainability and readability.

@wingkwong wingkwong modified the milestones: v2.5.0, v2.4.7 Aug 16, 2024
@wingkwong wingkwong assigned wingkwong and unassigned kuri-sun Sep 5, 2024
@wingkwong wingkwong requested review from wingkwong and removed request for jrgarciadev September 5, 2024 14:30
Copy link
Member

@wingkwong wingkwong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. can you share how to reproduce the issue?
  2. const disableAnimation = originalProps.disableAnimation ?? globalContext?.disableAnimation ?? false; happens in other components. Is it necessary to change them as well?

@wingkwong wingkwong removed this from the v2.4.7 milestone Sep 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📦 Scope : Components Related to the components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants