fix(input): isClearable & add test cases to input

[wingkwong]

Closes #2791

📝 Description

• use useSafeLayoutEffect to handle react-hook-form case. consistent with others
• add test case for isClearable
• add react hook form to input storybook (for test case, will be handled in another PR)

⛳️ Current behavior (updates)

with isClearable, users fail to clear the value due to the previous change

🚀 New behavior

with isClearable, users are able to clear the value.

pr2796-demo.webm

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

No

📝 Additional Information

Summary by CodeRabbit

• New Features

  • Enhanced the input component to support clear functionality with the isClearable option.
  • Introduced WithReactHookForm component for better form handling and validation using react-hook-form.

• Bug Fixes

  • Fixed an issue where the input value was not properly cleared when using the clear button.

• Tests

  • Added tests to ensure the clear functionality triggers the onClear callback correctly.

• Dependencies

  • Added react-hook-form to improve form state management and validation.

[linear]

ENG-672 [BUG] - Input Clear Button No Longer Working

[changeset-bot]

🦋 Changeset detected

Latest commit: fde03c2

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

This PR includes changesets to release 3 packages

Name	Type
@nextui-org/input	Patch
@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

[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	Apr 22, 2024 3:08pm
nextui-storybook-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 22, 2024 3:08pm

[coderabbitai]

Walkthrough

This update addresses a bug in the NextUI Input component where the clear button failed to visually clear the input field. The patch enhances the component's functionality, includes additional testing, integrates react-hook-form for better form handling, and improves state synchronization with input values.

Changes

File Path	Change Summary
.packages/components/input/__tests__/input.test.tsx	Updated the test suite for the Input component to include a test case for clearing the input value and triggering the onClear callback. Enhanced the test suite with a new case simulating a user clicking on the clear button to ensure proper behavior.
.packages/components/input/package.json	Added react-hook-form@^7.51.3 as a new dependency.
.packages/components/input/src/use-input.ts	Added useSafeLayoutEffect from @nextui-org/use-safe-layout-effect to synchronize input value with state when using react-hook-form. Adjusted logic to directly use inputValue.
.packages/components/input/stories/input.stories.tsx	Added WithReactHookForm component for form handling with react-hook-form.

Assessment against linked issues

Objective	Addressed	Explanation
Fix the input clear button issue where the text remains visible [#2791]	✅
Ensure the onClear callback is properly triggered when clearing [#2791]	✅
Validate integration with react-hook-form for form handling	✅	Although not explicitly linked to the issue, the integration is part of enhancing the component.

The changes effectively address the core issue of the clear button not working as expected by adjusting the component's internal handling of input clearing and state management. The addition of react-hook-form and new testing ensures robustness and functionality integrity.

---

Recent Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b53db66 and fde03c2.

Files selected for processing (1)

• packages/components/input/tests/input.test.tsx (2 hunks)

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

• packages/components/input/tests/input.test.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.

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.

[coderabbitai]

Actionable comments posted: 1

[coderabbitai]

Actionable comments posted: 1

[ryo-manba]

Looks good overall! I've left some comments on a few points.

[D4nGuerrero]

Updating the input value for React Hook Form actually introduces breaking changes. Previously, it would function with RHF's ASYNC default values because, as you mentioned, RHF uses ref.value. However, the value is now overwritten due to setInputValue being called first, which sets it to initial ref.value. As a result, async values come back, and RHF updates ref.value. However, NextUI's input state is already set so changing ref.value only reflects changes temporarily (and for input only), NextUI will use its own input state value.

Visual example:
https://github.com/nextui-org/nextui/assets/20586092/81531e3b-0694-4134-a203-05ac91c99a9b

Workarounds:
Setting the values yourself after async response, or a quicker way is to conditionally render Input/Select since they are not in the DOM yet this won't activate:

 useSafeLayoutEffect(() => {
    if (!domRef.current) return;

    setInputValue(domRef.current.value);
  }, [domRef.current]);
}