fix(image): add missing w to getWrapperProps dependency

[wingkwong]

Closes #3801

📝 Description

as titled

⛳️ Current behavior (updates)

pr3802-before.webm

🚀 New behavior

pr3802-after.webm

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

📝 Additional Information

Summary by CodeRabbit

• Bug Fixes
  • Updated the getWrapperProps function to include a missing dependency, enhancing functionality and reliability.
  • Modified the useEffect dependency array in the useImage function to ensure proper reactivity to changes in the w value, improving image rendering and layout adjustments.

[linear]

ENG-1397 [BUG] - Image width not updating max-width

[vercel]

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	Sep 24, 2024 4:54pm
nextui-storybook-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 24, 2024 4:54pm

[changeset-bot]

🦋 Changeset detected

Latest commit: 4042d44

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

[coderabbitai]

Walkthrough

A patch has been introduced for the @nextui-org/image package, specifically updating the getWrapperProps function to include a missing dependency w. This change ensures that the function references all necessary dependencies, enhancing its reliability. Additionally, the useEffect hook in the useImage function has been modified to include w in its dependency array, allowing the effect to re-run when w changes, which may influence image rendering and layout.

Changes

File Path	Change Summary
.changeset/shy-mails-live.md	Introduced a patch for @nextui-org/image, updating getWrapperProps to include w as a dependency.
packages/components/image/src/use-image.ts	Modified the useEffect dependency array in useImage to include w.

Assessment against linked issues

Objective	Addressed	Explanation
Image max-width not updating (Issue #3801)	✅

Possibly related PRs

• fix(image): override default auto height #3327: Modifies the useImage function in use-image.ts, impacting image property handling.
• fix(image): optional height #3420: A follow-up to fix(image): override default auto height #3327, also affecting the useImage function in use-image.ts.

Suggested reviewers

• jrgarciadev

---

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

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

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 (1)

.changeset/shy-mails-live.md (1)

1-5: LGTM! Changeset looks good.

The changeset correctly identifies the package and sets an appropriate version bump for this bug fix. The description is concise and references the relevant issue.

Consider slightly expanding the change description for more clarity:

- add missing `w` to `getWrapperProps` dependency (#3801)
+ add missing `w` property to `getWrapperProps` dependency to fix image width updating (#3801)

This provides a bit more context about the purpose of the change and its expected impact.

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e10ea00 and 4042d44.

Files selected for processing (2)

• .changeset/shy-mails-live.md (1 hunks)
• packages/components/image/src/use-image.ts (1 hunks)

Additional comments not posted (1)

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

191-191: Approved: Fix for image width not updating

This change correctly addresses the issue described in #3801. By adding w to the dependency array of getWrapperProps, the function will now re-compute when the width changes, ensuring that the wrapper's maxWidth is updated accordingly.

This fix will resolve the bug where the image's maximum width was not being updated, improving the component's responsiveness to width changes.