fix(autocomplete): ignore pointer events when the clear button is hidden
Closes #
📝 Description
-
opacity: 0causes the elements to be very transparent but users can still interact with them. -
On mobile, this gives a bit of annoying results where after clicking the button, the keyboard is shown again because the input is focused again. See RAC#6783
⛳️ Current behavior (updates)
https://github.com/nextui-org/nextui/assets/157580465/56767b0a-0315-434b-b8fd-453cbc5147c2
🚀 New behavior
https://github.com/nextui-org/nextui/assets/157580465/2a6a16f6-5873-4561-8fa8-3088ccd6efb8
💣 Is this a breaking change (Yes/No):
📝 Additional Information
Summary by CodeRabbit
-
New Features
- Enhanced AutoComplete component with improved visibility and interaction for the Clear Button.
- Refined focus management for mobile users to ensure a seamless experience when using the Clear Button.
-
Bug Fixes
- Resolved keyboard issue that affected the reopening of the AutoComplete component on mobile devices.
- Improved pointer event handling to prevent unintended interactions when the component is not visible.
🦋 Changeset detected
Latest commit: 8ceb3efa7d443c0711d51f43c2f96114b4235243
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/autocomplete | Patch |
| @nextui-org/theme | 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
The latest updates on your projects. Learn more about Vercel for Git ↗︎
| Name | Status | Preview | Comments | Updated (UTC) |
|---|---|---|---|---|
| nextui-storybook-v2 | ✅ Ready (Inspect) | Visit Preview | 💬 Add feedback | Aug 20, 2024 4:40am |
@chirokas is attempting to deploy a commit to the NextUI Inc Team on Vercel.
A member of the Team first needs to authorize it.
Walkthrough
The recent patch to @nextui-org/theme enhances the AutoComplete Clear Button functionality by enabling visibility control through CSS. New utility classes were introduced to manage visibility, pointer events, and interaction behaviors, particularly for mobile devices. These changes improve user experience by ensuring intuitive interactions and effective focus management, streamlining the codebase for better readability and maintainability.
Changes
| Files | Summary |
|---|---|
packages/core/theme/src/components/autocomplete.ts, packages/components/autocomplete/src/use-autocomplete.ts |
- Added utility classes to control visibility and pointer events. - Improved focus management and event handling for mobile interactions. - Simplified code by integrating callback functionalities into event handlers. |
.changeset/calm-rockets-shop.md |
Documented the patch details and the changes made in autocomplete.ts and use-autocomplete.ts. |
Sequence Diagram(s)
sequenceDiagram
participant User
participant AutoComplete
participant ClearButton
note over AutoComplete: Initial State
User->>AutoComplete: Types in text
AutoComplete->>ClearButton: Shows Clear Button
User->>ClearButton: Clicks Clear Button
ClearButton->>AutoComplete: Clears input
AutoComplete->>ClearButton: Hides Clear Button
note over AutoComplete: Final State
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?
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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto 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.yamlfile 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.
Visibility is an animatable property. However, the result looks terrible and gives a jarring effect. This is because it's a discrete animation.
A solution to this problem is to specify a transition on both visibility and opacity.
@chirokas what about pointer-events-none ?