Make projectInformation section optional instead of required

[rahul-vyas-dev]

This PR updates the component API by changing projectInformation section from required to optional. This improves flexibility for developers using the package, allowing the component to be used without providing that section when it is not needed.

This change is backward compatible and does not affect existing implementations.

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

• Documentation

  • Updated README to reflect that projectInformation is now optional in the API.

• Changes

  • Made projectInformation optional; the UI now gracefully handles cases where project information is not provided.
  • Updated project information display format and styling.

• Chores

  • Bumped version to 1.1.0.

[coderabbitai]

Walkthrough

The pull request makes the projectInformation field optional in the organizationInformation type definition, updates the SupportUsButton component to conditionally render project information sections when available, updates the README documentation to reflect the new optional status, and bumps the package version to 1.1.0.

Changes

Cohort / File(s)	Summary
Type Definition src/types/index.ts	Changed projectInformation field from required to optional in the exported organizationInformation type.
Component Logic src/components/SupportUsButton.tsx	Added conditional rendering for the horizontal line and project information block; restructured markup to display "ABOUT PROJECT: {name}" format only when projectInformation is present.
Documentation README.md	Updated API documentation to reflect that projectInformation within organizationInformation is now optional rather than required.
Package Metadata package.json	Bumped package version from 1.0.0 to 1.1.0.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

• chore: add TypeScript types for support us button component and updat… #5: Related modification to the same organizationInformation.projectInformation type field in src/types/index.ts.

Suggested labels

Typescript Lang, Documentation

Poem

🐰 A field once firmly required now bends with grace,
Optional it becomes in its rightful place,
When data flows, the component shall choose,
To render or rest—the flexibility we muse! ✨

🚥 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 accurately and concisely summarizes the main change: making projectInformation optional instead of required, which is reflected across type definitions, component rendering, and documentation updates.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

📝 Coding Plan

• Generate coding plan for human review comments

---

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

Tip

CodeRabbit can scan for known vulnerabilities in your dependencies using OSV Scanner.

OSV Scanner will automatically detect and report security vulnerabilities in your project's dependencies. No additional configuration is required.

[coderabbitai]

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)

src/components/SupportUsButton.tsx (2)

2-4: 🧹 Nitpick | 🔵 Trivial

Consider consolidating type imports.

Multiple imports from the same module can be combined into a single statement for cleaner code.

Suggested consolidation

-import type { supportUsButtonProps } from "../types/index";
-import type { Theme } from "../types/index";
-import type { ButtonVariant } from "../types/index";
+import type { supportUsButtonProps, Theme, ButtonVariant } from "../types/index";

🤖 Prompt for AI Agents

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

In `@src/components/SupportUsButton.tsx` around lines 2 - 4, The three separate
type imports (supportUsButtonProps, Theme, ButtonVariant) in SupportUsButton.tsx
should be consolidated into a single type import from the same module: replace
the multiple import statements with one import type that includes
supportUsButtonProps, Theme and ButtonVariant from "../types/index" to keep
imports concise and readable.

---

1-4: ⚠️ Potential issue | 🟡 Minor

Missing "use client" directive.

Per coding guidelines, NextJS components should include the "use client" directive. This component uses client-side React features and should be marked accordingly.

Proposed fix

+"use client";
+
 import React from "react";
 import type { supportUsButtonProps } from "../types/index";
 import type { Theme } from "../types/index";
 import type { ButtonVariant } from "../types/index";

As per coding guidelines: **/*.{ts,tsx,js,jsx}: NextJS: - Ensure that "use client" is being used.

🤖 Prompt for AI Agents

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

In `@src/components/SupportUsButton.tsx` around lines 1 - 4, The SupportUsButton
component is missing the Next.js "use client" directive; add the line "use
client" as the very first statement in the file (before any imports) so the
SupportUsButton React component and its client-side hooks/features are treated
as a client component; update the top of the file that contains the imports and
the SupportUsButton export to include that directive.

🤖 Prompt for all review comments with AI agents

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

Outside diff comments:
In `@src/components/SupportUsButton.tsx`:
- Around line 2-4: The three separate type imports (supportUsButtonProps, Theme,
ButtonVariant) in SupportUsButton.tsx should be consolidated into a single type
import from the same module: replace the multiple import statements with one
import type that includes supportUsButtonProps, Theme and ButtonVariant from
"../types/index" to keep imports concise and readable.
- Around line 1-4: The SupportUsButton component is missing the Next.js "use
client" directive; add the line "use client" as the very first statement in the
file (before any imports) so the SupportUsButton React component and its
client-side hooks/features are treated as a client component; update the top of
the file that contains the imports and the SupportUsButton export to include
that directive.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 3a0aae9d-8375-4f26-b65d-6b8055f39841

📥 Commits

Reviewing files that changed from the base of the PR and between 3c6cc74 and 3ca4a6d.

⛔ Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (4)

• README.md
• package.json
• src/components/SupportUsButton.tsx
• src/types/index.ts