docs(image): added note on removeWrapper for using img props directly

[awesome-pro]

Closes #3074

📝 Description

Adde Note to use removeWrapper={true} for using the img props directly.

⛳️ Current behavior (updates)

🚀 New behavior

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

📝 Additional Information

Summary by CodeRabbit

• Documentation
  • Added a note on the <Image /> component explaining how to access the properties of the <img /> element directly by setting removeWrapper={true}.
  • Expanded the note on selected keys in the Table component to emphasize treating row keys as strings to avoid type mismatch issues.

[changeset-bot[bot]]

⚠️ No Changeset found

Latest commit: e20f28b9691f7bcc62ca87588f98fae2a4525639

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[bot]]

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	Jul 26, 2024 1:04pm
nextui-storybook-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 26, 2024 1:04pm

[vercel[bot]]

@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[bot]]

Walkthrough

The changes introduce documentation updates for two NextUI components. The <Image /> component documentation now includes information about setting removeWrapper={true} to directly access <img /> properties, addressing a bug with Tailwind's object-cover. The <Table /> component documentation is updated to highlight the importance of treating row keys as strings to prevent type mismatch issues.

Changes

File Path	Change Summary
.../docs/components/image.mdx	Added a note about default structure and accessing <img /> properties using removeWrapper.
.../docs/components/table.mdx	Expanded the note on selected keys to stress treating row keys as strings for type consistency.

Sequence Diagram(s)

No sequence diagrams generated as the changes are documentation updates.

Assessment against linked issues

Objective (Issue #)	Addressed	Explanation
Introduce documentation for removeWrapper flag in <Image /> (3074)	✅
Ensure Table component documentation emphasizes string row keys	✅

---

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

[awesome-pro]

@wingkwong sir, if there are any syntax or Grammatical errors. Kindly inform I will update immediately. This PR is only aimed to avoid errors while using normal html img props in the Image component.

[wingkwong]

Closing - not really solve the issue