fix(input): missing clear button with file input type

[wingkwong]

Closes #4592

📝 Description

When setting isClearable to input with file type, the button is in DOM but hidden. This PR is to add the missing logic.

⛳️ Current behavior (updates)

🚀 New behavior

pr4599-demo.webm

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

📝 Additional Information

Summary by CodeRabbit

• Bug Fixes
  • Improved file input handling in the input component
  • Fixed clear button functionality for file input types
  • Ensured correct behavior when uploading and clearing files

The changes address an issue with file input handling, specifically improving the clear button's functionality and file upload management.

[linear]

ENG-1907 [BUG] - Input with type file does not show clear button when file selected

[changeset-bot]

🦋 Changeset detected

Latest commit: 6345030

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

This PR includes changesets to release 3 packages

Name	Type
@heroui/input	Patch
@heroui/autocomplete	Patch
@heroui/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)
heroui	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 19, 2025 11:04am
heroui-sb	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 19, 2025 11:04am

[coderabbitai]

Walkthrough

The pull request introduces a patch for the @heroui/input package, focusing on improving the clear button functionality for file input types. The changes are implemented in the useInput function within the use-input.ts file. The modifications enhance the input handling logic to better support file uploads by adding logic to detect uploaded files and correctly clear file inputs.

Changes

File	Change Summary
packages/components/input/src/use-input.ts	- Added hasUploadedFiles variable to check file upload status - Updated isFilled condition to include file uploads - Modified handleClear function to handle file input types specifically - Updated dependencies for handleClear function
.changeset/calm-seas-lie.md	Patch documentation for @heroui/input package

Sequence Diagram

sequenceDiagram
    participant User
    participant Input
    participant HandleClear

    User->>Input: Upload file
    Input-->>User: File uploaded
    User->>HandleClear: Trigger clear
    alt Is File Input
        HandleClear->>Input: Set input value to empty string
    else Other Input Types
        HandleClear->>Input: Clear controlled state
    end
    Input-->>User: Input cleared

Loading

The sequence diagram illustrates the new clear functionality, showing how the input clearing process differs between file inputs and other input types.

---

📜 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 103519c and 6345030.

📒 Files selected for processing (2)

• .changeset/calm-seas-lie.md (1 hunks)
• packages/components/input/src/use-input.ts (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: TypeScript
• GitHub Check: Build

🔇 Additional comments (5)

packages/components/input/src/use-input.ts (4)

143-144: Well-implemented file input detection!

The implementation safely checks for file input type and uploaded files using optional chaining, preventing potential null reference errors.

---

146-146: Good enhancement to isFilled logic!

Adding hasUploadedFiles to the condition ensures the input's filled state correctly reflects when files are uploaded, which is essential for proper clear button visibility.

---

162-162: Correct dependency list update!

Adding isFileTypeInput to the dependency array ensures the callback is properly memoized and updated when the input type changes.

---

154-158: Correct implementation of file input clearing!

The implementation properly handles both file and non-file input types. Direct DOM manipulation is the correct approach for clearing file inputs as they cannot be controlled via value property.

Let's verify that this implementation works across different browsers:

✅ Verification successful

Implementation verified as correct and browser-compatible

The implementation follows the standard DOM API approach for clearing file inputs, which is well-supported across all modern browsers. The code includes safeguards against common file input quirks, such as preventing the empty string value from blocking the first file upload attempt.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for browser-specific file input handling across the codebase
# Look for any existing browser-specific workarounds or issues

# Search for browser-specific file input handling
rg -i "file.*input.*browser|browser.*file.*input" --type ts --type tsx

# Look for existing file input related issues or workarounds
rg -i "input.*type.*file.*\b(fix|workaround|hack|safari|firefox|chrome)\b" --type ts --type tsx

Length of output: 226

---

Script:

#!/bin/bash
# Search for file input handling and browser-specific code
rg -t ts "file.*input|input.*type.*['\"]file" -A 3 -B 3

# Look for browser-specific handling or workarounds in input-related files
fd "input" --type f -e ts -e tsx --exec rg -i "\b(browser|safari|firefox|chrome|edge)\b" {}

Length of output: 759

.changeset/calm-seas-lie.md (1)

1-5: Well-structured changeset!

The patch version bump is appropriate for this bug fix, and the description clearly references the issue being addressed.

Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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

[ryo-manba]

LGTM, thanks!