fix(input): sync ref value to internal value

[AnthonyPaulO]

Closes #3024 Closes #3436 Closes #3678

📝 Description

Fixed issue where setting the ref value doesn't sync the internal state, causing ref value changes not to persist and reverting back to the internal (state) value.

⛳️ Current behavior (updates)

Ref value changes do not persist as they do not update the internal (state) value.

🚀 New behavior

Ref value changes will now update the internal (state) value.

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

No

📝 Additional Information

Video of fix: https://github.com/user-attachments/assets/1406b00f-7c5f-42ee-9f3e-37a3a0fb9f78

Summary by CodeRabbit

• New Features

  • Enhanced input component to synchronize its internal state with reference values, improving real-time data binding and responsiveness.

• Bug Fixes

  • Added a test case to ensure that changes to the reference value are accurately reflected in the input component’s internal state.

• Refactor

  • Improved the useInput hook for better control and handling of the input element's internal reference, increasing its flexibility and usability.

[changeset-bot[bot]]

🦋 Changeset detected

Latest commit: e6c9c902830f249298be5b689e56c34d33c0bc55

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[bot]]

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

A member of the Team first needs to authorize it.

[coderabbitai[bot]]

Walkthrough

The recent updates enhance the @nextui-org/input package by implementing a synchronization mechanism between a reference value and an internal state within the Input component. This ensures changes to the reference are reflected in the internal state, improving data consistency and responsiveness. A new test case has also been added to validate this functionality, and the useInput hook has been refined for better control over the input element's reference and state management.

Changes

File	Change Summary
.changeset/long-ducks-do.md	Introduces a patch for synchronization between reference and internal state in Input.
packages/components/input/tests/input.test.tsx	Adds test to verify synchronization between ref and internal value in Input.
packages/components/input/src/use-input.ts	Enhances useInput hook to use useRef, improving control over DOM reference and state updates.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Input
    participant useInput Hook

    User->>Input: Set reference value
    Input->>useInput Hook: Sync internal state
    useInput Hook->>Input: Update displayed value
    Input-->>User: Reflect updated value

Assessment against linked issues

Objective	Addressed	Explanation
Input component unresponsive to updates to value via ref (#3024)	✅
Setting ref value (i.e., uncontrolled) not supported by NextUI components (#3436)	✅

---

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

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

CodeRabbit Configuration 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[bot]]

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	Jul 23, 2024 1:21pm
nextui-storybook-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 23, 2024 1:21pm

[AnthonyPaulO]

@jrgarciadev When you have a chance, would you review this? I'd love to see this in the next release.

[chirokas]

@wingkwong https://github.com/user-attachments/assets/e6ff7bee-d9b1-4498-8c74-e127a8c315e3

[wingkwong]

@chirokas can u help take a look at this issue?