fix(component): update type definition to prevent primitive values as items

[ryo-manba]

Closes #2938

📝 Description

Fixed the type definitions of the component.

The same definition is applied in DatePicker:

nextui/packages/components/date-picker/src/date-picker.tsx

Lines 83 to 86 in 633f9d2

	export type DatePickerProps<T extends DateValue = DateValue> = Props<T> & {ref?: Ref<HTMLElement>};
	// forwardRef doesn't support generic parameters, so cast the result to the correct type
	export default forwardRef(DatePicker) as <T extends DateValue>(

⛳️ Current behavior (updates)

Arrays that contain non-object values can be passed to items, which leads to a runtime error.

🚀 New behavior

Passing arrays with non-object values to items will now raise a linting warning.

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

No.

📝 Additional Information

Summary by CodeRabbit

• Bug Fixes

  • Fixed type definitions across various UI components to ensure only object types are used as generic parameters, enhancing type safety and compatibility.

• Refactor

  • Updated type constraints in components like Autocomplete, Dropdown Menu, Listbox, Menu, Select, and Tabs to enforce stricter type checking.

[changeset-bot]

🦋 Changeset detected

Latest commit: 003fba0

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 8 packages

Name	Type
@nextui-org/autocomplete	Patch
@nextui-org/dropdown	Patch
@nextui-org/listbox	Patch
@nextui-org/menu	Patch
@nextui-org/select	Patch
@nextui-org/tabs	Patch
@nextui-org/use-aria-multiselect	Patch
@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

[coderabbitai]

Walkthrough

The recent updates across various UI components focus on refining type definitions to ensure that the generic type T extends object, thereby preventing the use of primitive values like strings or numbers as items. This change enhances type safety and compatibility across components such as Autocomplete, Dropdown Menu, Listbox, Menu, Select, and Tabs.

Changes

File Path	Change Summary
.../autocomplete/src/autocomplete.tsx	Updated AutocompleteProps to ensure T extends object.
.../dropdown/src/dropdown-menu.tsx	Updated generic type constraints in Props and DropdownMenuProps.
.../dropdown/src/use-dropdown.ts	Modified type parameter in getMenuProps function.
.../listbox/src/listbox.tsx	Updated ListboxProps to specify T extends object.
.../menu/src/menu.tsx	Updated MenuProps to ensure T extends object.
.../select/src/select.tsx	Refined SelectProps to specify T must extend object.
.../tabs/src/tabs.tsx	Updated TabsProps to ensure stricter type checking by requiring T extends object.

Assessment against linked issues

Objective	Addressed	Explanation
Prevent usage of scalar values as items in Select (#2938)	✅
Ensure type safety by refining generic type constraints across UI components (#2938)	✅
Address error with scalar values in Select by refining type constraints (#2938)	✅
Update type definitions to enhance compatibility and prevent type-related errors (#2938)	✅
Ensure the items parameter in Select strictly accepts objects, not scalars (#2938)	✅

The changes successfully address the issue of scalar values causing errors in the Select component by updating type definitions to enforce that all items must be objects, thereby aligning with the objectives outlined in the linked issue.

---

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[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	May 5, 2024 8:10am
nextui-storybook-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 5, 2024 8:10am

[coderabbitai]

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 633f9d2 and 003fba0.

Files selected for processing (8)

• .changeset/great-singers-repeat.md (1 hunks)
• packages/components/autocomplete/src/autocomplete.tsx (1 hunks)
• packages/components/dropdown/src/dropdown-menu.tsx (2 hunks)
• packages/components/dropdown/src/use-dropdown.ts (1 hunks)
• packages/components/listbox/src/listbox.tsx (1 hunks)
• packages/components/menu/src/menu.tsx (1 hunks)
• packages/components/select/src/select.tsx (1 hunks)
• packages/components/tabs/src/tabs.tsx (1 hunks)

Additional comments not posted (14)

.changeset/great-singers-repeat.md (1)

1-11: The changeset entries are correctly formatted and accurately reflect the updates made to the type definitions in the respective components.

packages/components/dropdown/src/dropdown-menu.tsx (2)

9-9: The updated interface definition correctly enforces that T extends object, ensuring that only objects can be passed as items.

---

23-26: The export statement correctly types the DropdownMenu component with the updated constraints and uses forwardRef to maintain the ref forwarding capability.

packages/components/menu/src/menu.tsx (2)

74-74: The updated interface definition for MenuProps correctly enforces that T extends object, aligning with the PR's objectives to prevent primitive values as items.

---

77-77: The export statement correctly types the Menu component with the updated constraints and uses forwardRef to maintain the ref forwarding capability.

packages/components/tabs/src/tabs.tsx (2)

60-60: The updated interface definition for TabsProps correctly enforces that T extends object, aligning with the PR's objectives to prevent primitive values as items.

---

63-63: The export statement correctly types the Tabs component with the updated constraints and uses forwardRef to maintain the ref forwarding capability.

packages/components/listbox/src/listbox.tsx (2)

79-79: The updated interface definition for ListboxProps correctly enforces that T extends object, aligning with the PR's objectives to prevent primitive values as items.

---

82-82: The export statement correctly types the Listbox component with the updated constraints and uses forwardRef to maintain the ref forwarding capability.

packages/components/autocomplete/src/autocomplete.tsx (2)

61-61: The updated interface definition for AutocompleteProps correctly enforces that T extends object, aligning with the PR's objectives to prevent primitive values as items.

---

64-64: The export statement correctly types the Autocomplete component with the updated constraints and uses forwardRef to maintain the ref forwarding capability.

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

135-135: The getMenuProps function correctly handles the type constraints by ensuring that T extends object, which aligns with the PR's objectives to enforce stricter type constraints.

packages/components/select/src/select.tsx (2)

147-147: The updated interface definition for SelectProps correctly enforces that T extends object, aligning with the PR's objectives to prevent primitive values as items.

---

150-150: The export statement correctly types the Select component with the updated constraints and uses forwardRef to maintain the ref forwarding capability.

[jrgarciadev]

Good catch, thanks @ryo-manba