Adding "fit" property inside Props Option Reference

[rahul-vyas-dev]

Added fit inside the Props Option Reference to let the user know about 'fit' props inside hero.

Checklist

• My code follows the project's code style and conventions
• I have made corresponding changes to the documentation
• My changes generate no new warnings or errors
• I have joined the Discord server and I will share a link to this PR with the project maintainers there
• I have read the Contributing Guidelines

⚠️ AI Notice - Important!

We encourage contributors to use AI tools responsibly when creating Pull Requests. While AI can be a valuable aid, it is essential to ensure that your contributions meet the task requirements, build successfully, include relevant tests, and pass all linters. Submissions that do not meet these standards may be closed without warning to maintain the quality and integrity of the project. Please take the time to understand the changes you are proposing and their impact.

Summary by CodeRabbit

• New Features
  • Added hero.fit prop to control how images are displayed in the hero section. Use "cover" to scale images while maintaining aspect ratio, or "contain" to prevent cropping and display the full image. This is particularly useful for logo-style images that need to remain completely visible without any portions being cut off.

[coderabbitai]

Walkthrough

The pull request adds documentation for a new hero.fit prop to the README's API reference. This prop accepts "cover" or "contain" values to handle logo-style images without cropping. No code logic, types, or other documented properties are modified.

Changes

Cohort / File(s)	Summary
Documentation README.md	Added hero.fit prop entry to API documentation table with accepted values "cover" | "contain" and description for handling logo-style images without cropping.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• feat(hero): add image fit prop to prevent SVG cropping #24: Implements the hero.fit prop in code (types and component) that is documented in this PR.

Suggested labels

Documentation

Poem

🐰 A hero arrives in the README's hall,
With fit to contain them, not cropping at all,
"cover" or "contain" the logo shall choose,
No more stretched images—only good news! 📚✨

🚥 Pre-merge checks | ✅ 2

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically describes the main change: adding documentation for a 'fit' property to the Props Option Reference in the README.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 291: Update the README table row for the `fit` property to a clear,
complete description: state that `fit` controls image sizing with the two
options and what each does (e.g., "Controls image sizing: 'cover' fills the area
and may crop, 'contain' fits the image without cropping"). Also consider
reordering the `fit` row to follow `description` to match the property order in
src/types/index.ts so the table reads consistently.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 56cb4b16-0074-4d96-855b-7797668a0af3

📥 Commits

Reviewing files that changed from the base of the PR and between 9d229d5 and 4bba660.

📒 Files selected for processing (1)

• README.md