fix(use-image): set status after hydrated

[wingkwong]

Closes #

📝 Description

follow-up of #4442

⛳️ Current behavior (updates)

The status was not set after hydrated in previous version. Therefore, the image is not loaded even hydrated.

🚀 New behavior

Update the status once it's hydrated

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

📝 Additional Information

Summary by CodeRabbit

• Bug Fixes

  • Improved image hook initialization to correctly handle status management during component hydration.
  • Updated dependency @nextui-org/use-image to address potential rendering inconsistencies.

• Chores

  • Refined image loading state management to ensure more predictable component behavior.

[changeset-bot]

🦋 Changeset detected

Latest commit: e1cc1d1

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

This PR includes changesets to release 5 packages

Name	Type
@nextui-org/use-image	Patch
@nextui-org/avatar	Patch
@nextui-org/image	Patch
@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]

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	Jan 3, 2025 2:19pm
nextui-storybook-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 3, 2025 2:19pm

[coderabbitai]

Walkthrough

The pull request introduces modifications to the useImage hook in the @nextui-org/use-image package. The primary changes focus on improving the status initialization and management during component hydration. The hook now sets the initial status to "pending" by default and adds a new useSafeLayoutEffect to update the status when the component becomes hydrated, ensuring more robust image loading state handling.

Changes

File	Change Summary
.changeset/fair-pigs-tap.md	Added patch for @nextui-org/use-image dependency
packages/hooks/use-image/src/index.ts	- Initialized status to "pending" by default - Added new useSafeLayoutEffect to update status after hydration - Maintained existing image loading logic

Sequence Diagram

sequenceDiagram
    participant Component as React Component
    participant UseImageHook as useImage Hook
    participant ImageLoader as Image Loader

    Component->>UseImageHook: Initialize with props
    UseImageHook->>UseImageHook: Set initial status to "pending"
    Note over UseImageHook: Hydration check
    UseImageHook->>ImageLoader: Determine initial status
    ImageLoader-->>UseImageHook: Return status
    UseImageHook->>Component: Update status after hydration

Loading

Possibly related PRs

• fix(use-image): cached image flickering issue #4442: The changes in this PR involve modifications to the useImage hook, specifically addressing hydration and image loading behavior, which directly relates to the changes made in the main PR regarding status management after hydration.

Suggested reviewers

• jrgarciadev

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f3de678 and e1cc1d1.

📒 Files selected for processing (1)

• packages/hooks/use-image/src/index.ts (3 hunks)

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

• packages/hooks/use-image/src/index.ts

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.