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): use onPress for wrapper click focus #4483

Open
wants to merge 4 commits into
base: canary
Choose a base branch
from

Conversation

Peterl561
Copy link
Contributor

@Peterl561 Peterl561 commented Jan 3, 2025

Closes #4287
note that this bug occurs in docs due to the Overlay from NavbarMenu, which is another bug (see #4490)

📝 Description

  • when Input wrappers are clicked, an onClick handler focuses the <input>
  • this causes issues as it bypasses Overlay's ability to control focus (don't quote me on this)
  • use onPress instead for consistency
  • added a test for input click focus

⛳️ Current behavior (updates)

clicking on input (blue) will close listbox first due to Modal Overlay while clicking on wrapper (red) will immediately focus on input due to onClick ignoring Overlay

before.mp4

🚀 New behavior

with onPress, clicking wrapper (red) will behave the same as clicking input (blue)

after.mp4

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

No

📝 Additional Information

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Enhanced input component interaction by ensuring consistent focus when clicking on input wrappers.
    • Improved user experience for input field interactions.
  • Tests

    • Added test case to verify input focusing behavior when clicking the input or its wrappers.
  • Bug Fixes

    • Resolved input focus management for consistent user interaction across different input wrapper scenarios.

@Peterl561 Peterl561 requested a review from jrgarciadev as a code owner January 3, 2025 07:26
Copy link

vercel bot commented Jan 3, 2025

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 Jan 4, 2025 1:55am
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 4, 2025 1:55am

Copy link
Contributor

coderabbitai bot commented Jan 3, 2025

Walkthrough

The pull request introduces changes to the @nextui-org/input package, focusing on improving input component interaction. The modifications enhance the focus behavior by implementing a new method handleInputWrapperClick that allows focusing the input element when its wrapper is clicked. This change is implemented using the usePress hook and modifies the input component's interaction handling to provide a more intuitive user experience.

Changes

File Change Summary
packages/components/input/src/use-input.ts - Added handleInputWrapperClick function
- Introduced inputWrapperPressProps using usePress hook
- Modified getInputWrapperProps to include new press properties
packages/components/input/__tests__/input.test.tsx - Added new test case to verify input focus behavior
- Tested clicking on input, inner wrapper, and input wrapper
.changeset/friendly-hounds-walk.md Patch file for the @nextui-org/input package

Assessment against linked issues

Objective Addressed Explanation
Popover-based components opening issue [#4287] Partial improvement in focus handling, but may not fully resolve popover opening inconsistency

Possibly related PRs

Suggested labels

👀 Status: To Review

Suggested reviewers

  • wingkwong
  • jrgarciadev

📜 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 0066510 and ea787c3.

📒 Files selected for processing (1)
  • .changeset/friendly-hounds-walk.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .changeset/friendly-hounds-walk.md

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.

@Peterl561 Peterl561 changed the title Fix/input wrapper press focus fix(input): use onPress for wrapper click focus Jan 3, 2025
@wingkwong wingkwong added this to the v2.6.11 milestone Jan 3, 2025
Copy link

changeset-bot bot commented Jan 4, 2025

🦋 Changeset detected

Latest commit: ea787c3

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

@jrgarciadev
Copy link
Member

@wingkwong please check

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] - Popover-based components (such as Autocomplate, Dropdown, Popover etc...) do not open as expected.
3 participants