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(#3640) : errorFallbackSrc and loadingFallbackSrc props to image component #3665

Closed
wants to merge 3 commits into from

Conversation

abhinav700
Copy link
Contributor

@abhinav700 abhinav700 commented Aug 19, 2024

Closes #3640

📝 Description

⛳️ Current behavior (updates)

Fallback displays same fallback image for error and loading state

🚀 New behavior

errorFallbackSrc and loadingFallbackSrc props are added to display different fallbacks for both states.

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

I don't know

Summary by CodeRabbit

  • New Features

    • Introduced errorFallbackSrc and loadingFallbackSrc properties for improved image handling during loading and error states.
    • Enhanced user experience by displaying relevant placeholder images instead of broken icons during loading errors.
  • Documentation

    • Updated documentation to reflect the new properties and provide clearer usage instructions for the Image component.

Copy link

changeset-bot bot commented Aug 19, 2024

🦋 Changeset detected

Latest commit: 105107b

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

Copy link

vercel bot commented Aug 19, 2024

@abhinav700 is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Aug 19, 2024

Walkthrough

This change enhances the @nextui-org/image component by introducing two new properties, errorFallbackSrc and loadingFallbackSrc, for improved image loading management. This allows developers to define distinct fallback images for loading and error states, enhancing user experience by preventing broken image icons and providing relevant visual feedback during image transitions.

Changes

File Change Summary
.changeset/small-gifts-learn.md Added errorFallbackSrc and loadingFallbackSrc properties for image loading states.
apps/docs/content/components/image/fallback.ts Updated App component to include errorFallbackSrc and loadingFallbackSrc.
apps/docs/content/docs/components/image.mdx Refined Image component logic to utilize separate properties for loading and error states.
packages/components/image/src/use-image.ts Enhanced useImage hook to handle new fallback images based on loading and error conditions.
packages/components/image/stories/image.stories.tsx Updated stories to demonstrate the new fallback properties for loading and error states.

Assessment against linked issues

Objective Addressed Explanation
Make a distinction between loading and error states in the Image component (#[3640])
Allow separate images for loading and error states

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 4f8ae50 and 105107b.

Files selected for processing (5)
  • .changeset/small-gifts-learn.md (1 hunks)
  • apps/docs/content/components/image/fallback.ts (1 hunks)
  • apps/docs/content/docs/components/image.mdx (2 hunks)
  • packages/components/image/src/use-image.ts (5 hunks)
  • packages/components/image/stories/image.stories.tsx (1 hunks)
Additional comments not posted (8)
.changeset/small-gifts-learn.md (1)

1-5: Changeset looks good.

The changeset entry accurately describes the introduction of errorFallbackSrc and loadingFallbackSrc properties as a minor change.

apps/docs/content/components/image/fallback.ts (1)

10-11: Example usage looks good.

The example correctly demonstrates how to use errorFallbackSrc and loadingFallbackSrc properties.

Consider verifying that this example is referenced in the documentation to ensure users can easily find it.

packages/components/image/stories/image.stories.tsx (1)

135-136: Storybook example updated correctly.

The Fallback story now includes errorFallbackSrc and loadingFallbackSrc, providing a clear demonstration of the new functionality.

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

33-34: New properties added to Props interface.

The errorFallbackSrc and loadingFallbackSrc properties are correctly added to the Props interface.


190-200: Fallback logic correctly implemented.

The logic for determining which fallback image to display is well-structured and ensures the correct image is shown based on the loading state.


94-95: New properties integrated into useImage hook.

The useImage hook now includes logic to handle errorFallbackSrc and loadingFallbackSrc, enhancing the component's flexibility.

Consider verifying that existing functionality is not adversely affected by these changes.

apps/docs/content/docs/components/image.mdx (2)

71-82: Documentation updated with new properties.

The documentation correctly explains the usage of errorFallbackSrc and loadingFallbackSrc, providing clear guidance for developers.


118-119: API table updated with new properties.

The API table now includes errorFallbackSrc and loadingFallbackSrc, ensuring comprehensive documentation of the component's capabilities.

@wingkwong
Copy link
Member

will be handled in #3664

@wingkwong wingkwong closed this Aug 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request] Make a Distinction Between Loading and Error States in Image Component
2 participants