refactor: remove unnecessary props types

[wingkwong]

Closes #

📝 Description

Given that ReactNode already unions string and null, we don't need to union them again.

type ReactNode =
    | ReactElement
    | string
    | number
    | ReactFragment
    | ReactPortal
    | boolean
    | null
    | undefined
    | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_REACT_NODES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_REACT_NODES];

⛳️ Current behavior (updates)

🚀 New behavior

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

📝 Additional Information

Summary by CodeRabbit

• Documentation
  • Updated type definitions for various components to improve type safety
  • Refined prop types for Accordion, Navbar, Listbox, Menu, Snippet, Tabs, and User components
  • Removed string and null options from several component properties
  • Enforced stricter React node type requirements across multiple components

[changeset-bot]

⚠️ No Changeset found

Latest commit: 61756cb

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]

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 13, 2025 6:01am
nextui-storybook-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 13, 2025 6:01am

[coderabbitai]

Walkthrough

The pull request introduces type safety improvements across multiple components in the CodeRabbit UI library. The changes primarily focus on refining type definitions for various component props, removing string and null options in favor of strictly ReactNode types. This affects components like Accordion, Navbar, Listbox, Menu, Snippet, Tabs, and User, ensuring more consistent and predictable prop handling across the library.

Changes

File Path	Change Summary
apps/docs/content/docs/components/accordion.mdx	Updated AccordionItem prop types to use only ReactNode
apps/docs/content/docs/components/navbar.mdx	Modified icon prop type in NavbarMenuToggle to always return ReactNode
packages/components/accordion/*	Removed null and string type options for children, title, and subtitle
packages/components/listbox/*	Restricted children, title, and description to ReactNode
packages/components/menu/*	Updated prop types to use only ReactNode for various properties
packages/components/snippet/src/use-snippet.ts	Removed string[] option from children prop
packages/components/tabs/src/base/tab-item-base.ts	Removed null option for children and title
packages/components/user/src/use-user.ts	Changed name and description to only accept ReactNode

Possibly related PRs

• refactor(docs): dx improvement in accordion #3856: Refactors accordion component documentation
• fix(avatar): title type in Avatar #4529: Changes Avatar component title type to ReactNode
• fix(alert): mark description optional & revise styles when only children is provided #4447: Modifies Alert component description type

Suggested Labels

📋 Scope : Docs, 🔧 Type: Refactoring, 🛡️ Type Safety

Suggested Reviewers

• jrgarciadev

Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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.

[ryo-manba]

LGTM, thanks.

It could also be addressed separately, but we might be able to remove null as well.
https://github.com/search?q=repo%3Anextui-org%2Fnextui+%22ReactNode+%7C+null%22&type=code

[coderabbitai]

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between eada8cb and 61756cb.

📒 Files selected for processing (11)

• apps/docs/content/docs/components/accordion.mdx (1 hunks)
• apps/docs/content/docs/components/navbar.mdx (1 hunks)
• packages/components/accordion/src/accordion-item.tsx (1 hunks)
• packages/components/accordion/src/base/accordion-item-base.tsx (1 hunks)
• packages/components/listbox/src/base/listbox-item-base.tsx (1 hunks)
• packages/components/listbox/src/listbox-item.tsx (1 hunks)
• packages/components/menu/src/base/menu-item-base.tsx (1 hunks)
• packages/components/menu/src/menu-item.tsx (1 hunks)
• packages/components/snippet/src/use-snippet.ts (1 hunks)
• packages/components/tabs/src/base/tab-item-base.ts (1 hunks)
• packages/components/user/src/use-user.ts (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: TypeScript
• GitHub Check: Build

🔇 Additional comments (10)

packages/components/tabs/src/base/tab-item-base.ts (1)

7-7: LGTM! Simplified type definitions

The changes correctly remove redundant null from union types since ReactNode already includes null. This aligns with the PR objective and maintains the same runtime behavior.

Also applies to: 11-11

packages/components/listbox/src/listbox-item.tsx (1)

32-32: LGTM! Type matches implementation

The type change to ReactNode accurately reflects the implementation, as the logic always returns a valid ReactNode and never returns null.

packages/components/menu/src/menu-item.tsx (1)

35-35: LGTM! Type matches implementation

The type change to ReactNode accurately reflects the implementation, as the logic always returns a valid ReactNode and never returns null.

packages/components/user/src/use-user.ts (1)

20-20: LGTM! Simplified type definitions

The changes correctly remove redundant string from union types since ReactNode already includes string. This aligns with the PR objective and maintains the same runtime behavior.

Also applies to: 24-24

packages/components/menu/src/base/menu-item-base.tsx (1)

28-28: LGTM! Type definitions simplified correctly.

The changes correctly remove redundant union types since ReactNode already includes both string and null. This maintains type safety while making the types more concise.

Also applies to: 32-32, 36-36, 40-40

packages/components/accordion/src/base/accordion-item-base.tsx (1)

36-36: LGTM! Type definitions simplified correctly.

The changes correctly remove redundant union types since ReactNode already includes both string and null. This maintains type safety while making the types more concise.

Also applies to: 40-40, 44-44

packages/components/listbox/src/base/listbox-item-base.tsx (1)

28-28: LGTM! Type definitions simplified correctly.

The changes correctly remove redundant union types since ReactNode already includes both string and null. This maintains type safety while making the types more concise.

Also applies to: 32-32, 36-36

packages/components/accordion/src/accordion-item.tsx (1)

43-43: LGTM! Type annotation simplified correctly.

The type annotation change for indicatorContent correctly removes the redundant union with null since ReactNode already includes null. The function can still return null explicitly, maintaining the same behavior.

apps/docs/content/docs/components/navbar.mdx (1)

415-415: LGTM! Improved type safety.

The removal of null from the return type enforces that the icon function must always return a valid ReactNode, preventing potential null pointer issues.

apps/docs/content/docs/components/accordion.mdx (1)

330-342: LGTM! Type definitions simplified.

The removal of explicit string type from children, title, and subtitle props is correct as ReactNode already includes string. This change simplifies the type definitions without affecting functionality.