feat(select): add isClearable

[abhinav700]

Closes #2239

📝 Description

Added clear button functionality to select component.

Summary by CodeRabbit

• New Features

  • Introduced isClearable property to the select component, allowing users to easily clear their selection.
  • Added onClear event handler for custom actions when the selection is cleared.
  • Updated documentation with a new section on the clear button functionality.

• Bug Fixes

  • Enhanced the styling and responsiveness of the clear button across different component sizes.

• Tests

  • Added a new component template to demonstrate the clearable feature in the select component stories.

[changeset-bot]

🦋 Changeset detected

Latest commit: 179b530

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

This PR includes changesets to release 2 packages

Name	Type
@nextui-org/select	Minor
@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

[vercel]

@abhinav700 is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

The pull request introduces two key features to the @nextui-org/select component: the isClearable property and the onClear event handler. The isClearable prop allows users to enable a clear button for easily resetting selections, while the onClear handler enables custom actions when the clear button is activated. These enhancements are reflected across various files, including component logic, documentation, and styling.

Changes

Files	Change Summary
.changeset/olive-buckets-own.md	Added isClearable prop and onClear event handler to the @nextui-org/select component.
apps/docs/content/components/select/index.ts	Exported new isClearable property in selectContent.
apps/docs/content/components/select/isClearable.ts	Introduced a new React component demonstrating the isClearable functionality with a dataset of animals.
apps/docs/content/docs/components/select.mdx	Updated documentation to include isClearable and onClear properties, with a new "Clear Button" section.
packages/components/select/src/select.tsx	Implemented logic for rendering a clear button when isClearable is true, including associated styling.
packages/components/select/src/use-select.ts	Enhanced useSelect hook to manage clear button functionality and added onClear callback prop.
packages/components/select/stories/select.stories.tsx	Added ClearableTemplate to showcase clearable and non-clearable Select component variations.
packages/core/theme/src/components/select.ts	Added styles for the clearButton, including responsive design settings and interactions based on isClearable.

Assessment against linked issues

Objective	Addressed	Explanation
Add isClearable option for Select (#2239)	✅
Allow users to clear selection easily (#2239)	✅
Provide a way to handle clear action (#2239)	✅

Possibly related PRs

• fix(select): prevent select from closing instantly when clicking on label of select #3568: Addresses a bug in the Select component related to color discrepancies, which aligns with the changes made in this PR.
• fix(input): prevent clearable when input is readonly #3643: Fixes an issue with the clear button being incorrectly enabled when the input field was set to read-only, relevant to the new functionality.
• [BUG] - Select TypeScript issues #3562: Focuses on usability improvements in the Select component, which complements the enhancements made in the main PR regarding the isClearable feature and onClear event handler.

Suggested labels

👀 Status: In Review

Tip

OpenAI O1 model for chat

• We have deployed OpenAI's latest O1 model for chat.
• OpenAI claims that this model has superior reasoning capabilities than their GPT-4o model.
• Please share any feedback with us in the discussions post.

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c683694 and 179b530.

Files selected for processing (2)

• apps/docs/content/components/select/isClearable.ts (1 hunks)
• packages/components/select/stories/select.stories.tsx (2 hunks)

Files skipped from review as they are similar to previous changes (2)

• apps/docs/content/components/select/isClearable.ts
• packages/components/select/stories/select.stories.tsx

---

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

[abhinav700]

@wingkwong for the tests that are failing, I don't think they are related to the changes that I have made.

When I tried to run the tests on the canary branch( which is in sync and I have pulled those changes locally), the same tests are failing there also even though I have not made any changes to it.