Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(autocomplete): clear autocomplete value when pressing clear button #4458

Merged
merged 1 commit into from
Jan 2, 2025

Conversation

wingkwong
Copy link
Member

@wingkwong wingkwong commented Dec 29, 2024

Closes #4402

📝 Description

Currently you can clear the arbitrary value in autocomplete by pressing clear button only when allowsCustomValue is set to true. If a user tries to search something, then clicking clear button will not clear the value. This PR is to make autocomplete to clear the value in all cases.

⛳️ Current behavior (updates)

🚀 New behavior

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

📝 Additional Information

Summary by CodeRabbit

  • New Features

    • Enhanced autocomplete component clear button functionality
    • Improved user interaction for clearing input values
  • Bug Fixes

    • Resolved issues with clearing autocomplete input
    • Ensured consistent behavior when using clear button
  • Tests

    • Added test case to verify clear button functionality
    • Improved test coverage for autocomplete component

Copy link

linear bot commented Dec 29, 2024

Copy link

changeset-bot bot commented Dec 29, 2024

🦋 Changeset detected

Latest commit: 117310c

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/autocomplete 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

Copy link

vercel bot commented Dec 29, 2024

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 Dec 29, 2024 2:20pm
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 29, 2024 2:20pm

@wingkwong wingkwong added this to the v2.6.11 milestone Dec 29, 2024
Copy link
Contributor

coderabbitai bot commented Dec 29, 2024

Walkthrough

The pull request addresses a bug in the @nextui-org/autocomplete package where the clear button functionality was not working as expected. The changes modify the useAutocomplete hook to ensure that the input value is always cleared when the clear button is pressed, regardless of the selected item state. A new test case has been added to verify this behavior, enhancing the component's user interaction and testing coverage.

Changes

File Change Summary
.changeset/nice-books-yell.md Patch introduction for @nextui-org/autocomplete package
packages/components/autocomplete/__tests__/autocomplete.test.tsx Added test case to verify clear button functionality
packages/components/autocomplete/src/use-autocomplete.ts Updated clear button handling logic and simplified input clearing mechanism

Assessment against linked issues

Objective Addressed Explanation
Clear Autocomplete input when clear button is pressed [#4402]
Ensure clear button works after typing text

Possibly related PRs

Suggested reviewers

  • jrgarciadev

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4f0ef58 and 117310c.

📒 Files selected for processing (3)
  • .changeset/nice-books-yell.md (1 hunks)
  • packages/components/autocomplete/__tests__/autocomplete.test.tsx (1 hunks)
  • packages/components/autocomplete/src/use-autocomplete.ts (1 hunks)
🔇 Additional comments (3)
packages/components/autocomplete/src/use-autocomplete.ts (1)

423-424: **Double-check the always-open logic after clearing **

By calling state.open() immediately after clearing the input value, the dropdown will always remain open. While this aligns with the new requirement (to clear the field and keep suggestions visible), confirm whether this is the intended behavior in all user scenarios.

Would you like to run additional tests to confirm that users do not find the always-open behavior confusing, especially if they simply want to reset the field without continuing to browse options?

packages/components/autocomplete/__tests__/autocomplete.test.tsx (1)

238-280: **Good addition to test coverage **

The new test ("should clear arbitrary value after clicking clear button") thoroughly ensures that manually-typed input is cleared properly. This improves reliability and user experience by verifying the new clear~functionality.

.changeset/nice-books-yell.md (1)

1-5: **Accurate changelog entry **

This changeset clearly documents the improvement of clearing the autocomplete value when pressing the clear button, referencing issue #4402. Keeping the changelog concise and descriptive helps maintainers and users understand intentional fixes.


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

Copy link
Member

@ryo-manba ryo-manba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, LGTM!

@jrgarciadev jrgarciadev merged commit 7c2bc4a into canary Jan 2, 2025
8 checks passed
@jrgarciadev jrgarciadev deleted the fix/eng-1762 branch January 2, 2025 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] - Autocomplete don't clear when you write and press clear button
3 participants