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(input): label placement with file input type #4366

Merged
merged 1 commit into from
Dec 17, 2024
Merged

Conversation

wingkwong
Copy link
Member

@wingkwong wingkwong commented Dec 15, 2024

Closes #4364

📝 Description

Not sure what was the reason why inside is not supported. Probably this logic was added before changing data-filled & data-filled-within.

⛳️ Current behavior (updates)

When using labelPlacement=inside, it throws Input with file type doesn't support inside label. Converting to outside ...

🚀 New behavior

image

image

image

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

📝 Additional Information

Summary by CodeRabbit

  • New Features

    • Improved label placement for file input types, enhancing visual alignment and usability.
  • Bug Fixes

    • Simplified label placement logic for file inputs, eliminating unnecessary warnings and improving control flow.
  • Documentation

    • Minor adjustments made to comments and documentation for better clarity.

@wingkwong wingkwong added this to the v2.6.9 milestone Dec 15, 2024
Copy link

linear bot commented Dec 15, 2024

Copy link

changeset-bot bot commented Dec 15, 2024

🦋 Changeset detected

Latest commit: d873d4f

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

Copy link

vercel bot commented Dec 15, 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 15, 2024 8:16am
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 15, 2024 8:16am

Copy link
Contributor

coderabbitai bot commented Dec 15, 2024

Walkthrough

This pull request addresses a bug in the @nextui-org/input package related to label placement for file input types. The changes modify the use-input.ts file to simplify the label placement logic, removing previous warning mechanisms and ensuring that labels can be positioned correctly for file inputs. The modification aims to resolve inconsistent label positioning when labelPlacement="inside" is used with file input elements.

Changes

File Change Summary
.changeset/chilly-rules-marry.md Patch for @nextui-org/input package addressing label placement
packages/components/input/src/use-input.ts Removed warn import, simplified label placement logic, updated getInputProps to chain onChange handlers

Assessment against linked issues

Objective Addressed Explanation
Label placement for file inputs [#4364]
Support labelPlacement="inside" for file inputs

Possibly related PRs

Suggested labels

👀 Status: In Review, 📋 Scope : Docs

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. This feature will be included in our Pro Plan when released.


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
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/components/input/src/use-input.ts (1)

Line range hint 1-489: Consider adding test cases for file input scenarios.

The implementation looks solid and properly fixes the file input label placement issue. To ensure long-term maintainability and prevent regressions, consider adding test cases that cover:

  1. File input with different label placements
  2. File input interaction with data attributes
  3. File input styling consistency
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8d53e8b and d873d4f.

📒 Files selected for processing (2)
  • .changeset/chilly-rules-marry.md (1 hunks)
  • packages/components/input/src/use-input.ts (1 hunks)
🔇 Additional comments (5)
.changeset/chilly-rules-marry.md (1)

1-5: LGTM! Changeset correctly configured for the bug fix.

The changeset properly identifies this as a patch update for the input component, which is appropriate for a bug fix addressing label placement.

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

16-16: LGTM! Simplified imports by removing unused warn utility.

The removal of the warn import aligns with the removal of the file input type warning message.


Line range hint 182-189: LGTM! Correct handling of file input props.

The special handling for file input type is well-implemented. Removing the value and onChange props is crucial as they would otherwise block the first attempt of file upload with an empty string value.


Line range hint 314-329: LGTM! Proper handling of data attributes for file inputs.

File inputs are now correctly handled in the data attributes by being considered as "filled", which ensures proper styling and visual consistency.


Line range hint 279-285: Verify the impact on existing file input implementations.

The label placement logic has been simplified to treat file inputs like other input types. While this is a good change, we should ensure it doesn't affect existing implementations.

✅ Verification successful

File input handling remains consistent and properly implemented

The code shows that file inputs are still handled appropriately with special considerations:

  • The component correctly removes value and onChange props for file inputs to prevent blocking file uploads
  • The stories demonstrate both single and multiple file input usage without any label placement issues
  • There's no evidence of any breaking changes in the label placement logic for file inputs
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for file input usage with label placement
rg -l 'type="file".*labelPlacement' || rg -l 'labelPlacement.*type="file"'

Length of output: 75


Script:

#!/bin/bash
# Let's try a broader search for file input usage in the codebase
rg -l 'type="file"' 

# Also search for any test files that might be testing file input behavior
rg -l 'file.*input' '**/*test*' '**/*spec*'

# Search for any documentation or examples of file input usage
fd -g '*docs*.{tsx,ts,mdx,md}' -x rg -l 'file.*input' {}

Length of output: 323


Script:

#!/bin/bash
# Let's examine the actual implementation and usage in the found files
rg -A 5 -B 5 'type="file"' packages/components/input/src/use-input.ts packages/components/input/stories/input.stories.tsx

# Check if there were any previous special cases for file inputs
git log -p packages/components/input/src/use-input.ts | rg -A 5 -B 5 'file.*input'

Length of output: 2211

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] - Label of Input of type File, never goes inside
2 participants