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(autocomplete): hide clear button with visibility: hidden #3000

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

Conversation

chirokas
Copy link
Contributor

@chirokas chirokas commented May 14, 2024

Closes #

📝 Description

Stacked on #3217.

opacity: 0 causes the elements to be very transparent but users can still interact with them.

It is needed to transition opacity along with visibility to enable and disable the interactivity of elements.

⛳️ Current behavior (updates)

20240514_160517.mp4

🚀 New behavior

20240514_160634.mp4

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

📝 Additional Information

Summary by CodeRabbit

  • New Features
    • Enabled showing and hiding the AutoComplete Clear Button using CSS visibility settings.

Copy link

changeset-bot bot commented May 14, 2024

🦋 Changeset detected

Latest commit: 728e4d5

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

This PR includes changesets to release 2 packages
Name Type
@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

Copy link

vercel bot commented May 14, 2024

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 Jun 11, 2024 3:39pm

Copy link

vercel bot commented May 14, 2024

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

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented May 14, 2024

Walkthrough

The recent update to @nextui-org/theme introduces a patch that allows the AutoComplete Clear Button's visibility to be toggled using CSS classes. This improvement involves adding "invisible" and "visible" classes, adjusting visibility and opacity settings for different screen sizes, and incorporating a transition class for smoother visual effects.

Changes

File Path Change Summary
.changeset/calm-rockets-shop.md Introduced a patch for toggling AutoComplete Clear Button visibility using CSS.
packages/core/theme/src/components/... Added "invisible" and "visible" classes, updated visibility and opacity settings, and added a transition class for the clear button.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AutoComplete
    participant ClearButton
    participant CSS

    User->>AutoComplete: Types in input
    AutoComplete-->>ClearButton: Show clear button (visible class)
    User->>ClearButton: Clicks clear button
    ClearButton-->>CSS: Apply invisible class
    CSS-->>ClearButton: Hide clear button

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>.
    • 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 Configration 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.

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

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 8988981 and 856ed1e.
Files selected for processing (2)
  • .changeset/calm-rockets-shop.md (1 hunks)
  • packages/core/theme/src/components/autocomplete.ts (1 hunks)
Files skipped from review due to trivial changes (1)
  • .changeset/calm-rockets-shop.md
Additional comments not posted (4)
packages/core/theme/src/components/autocomplete.ts (4)

17-17: The addition of the "invisible" class ensures that the clear button is not only invisible but also non-interactive. This aligns with the intended behavior described in the PR summary.


21-21: Changing "data-[visible=true]:visible" to "data-[visible=true]:invisible" ensures that the clear button is non-interactive when hidden, which aligns with the intended behavior.


24-24: Adding "sm:data-[visible=true]:invisible" ensures that the clear button is non-interactive on small screens when hidden, which aligns with the intended behavior.


26-26: Changing "sm:group-data-[hover=true]:data-[visible=true]:visible" to "sm:group-data-[hover=true]:data-[visible=true]:invisible" ensures that the clear button is non-interactive on small screens when hovered, which aligns with the intended behavior.

@wingkwong wingkwong self-assigned this May 14, 2024
Copy link
Member

@wingkwong wingkwong left a comment

Choose a reason for hiding this comment

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

I'm wondering if we need to keep both at the same time.

@chirokas
Copy link
Contributor Author

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.

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: 1

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 856ed1e and 728e4d5.

Files selected for processing (3)
  • .changeset/calm-rockets-shop.md (1 hunks)
  • packages/core/theme/src/components/autocomplete.ts (2 hunks)
  • packages/core/theme/src/utilities/transition.ts (1 hunks)
Files skipped from review due to trivial changes (2)
  • .changeset/calm-rockets-shop.md
  • packages/core/theme/src/utilities/transition.ts
Additional comments not posted (1)
packages/core/theme/src/components/autocomplete.ts (1)

42-42: The addition of transition-transform-colors-opacity-visibility to the clearButton is a significant improvement, ensuring smooth transitions for visibility changes. This aligns well with the PR's objectives to enhance UX by managing the interactivity of UI elements more effectively.

Comment on lines +17 to +26
"invisible",
"text-default-500",
"group-data-[invalid=true]:text-danger",
"data-[visible=true]:opacity-100", // on mobile is always visible when there is a value
"data-[visible=true]:visible",
"data-[visible=true]:cursor-pointer",
"sm:data-[visible=true]:opacity-0", // only visible on hover
"sm:data-[visible=true]:invisible",
"sm:group-data-[hover=true]:data-[visible=true]:opacity-100",
"sm:group-data-[hover=true]:data-[visible=true]:visible",
Copy link
Contributor

Choose a reason for hiding this comment

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

Tip

Codebase Verification

The invisible class is referenced in the code but does not appear to be defined anywhere in the codebase. This could lead to issues with the intended functionality of the clearButton styles.

  • Ensure that the invisible class is defined in your stylesheets.
Analysis chain

The changes to the clearButton styles introduce conditional visibility and opacity, which are crucial for improving UX by making the button non-interactive when not visible. However, ensure that the invisible class is defined elsewhere in your stylesheets, as it's being used here without prior definition in the provided code.

Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the definition of the `invisible` class in stylesheets.

# Test: Search for the `invisible` class definition in CSS or TypeScript files.
rg --type css --type ts 'invisible' --files-with-matches

Length of output: 245



Script:

#!/bin/bash
# Description: Search for the definition of the `invisible` class in CSS or TypeScript files.

# Test: Find the definition of the `invisible` class.
rg --type css --type ts '\.invisible\s*{'

Length of output: 137



Script:

#!/bin/bash
# Description: Search for the definition of the `invisible` class in CSS or TypeScript files.

# Test: Find the definition of the `invisible` class.
rg --type css --type ts '\.invisible\s*\{'

Length of output: 44



Script:

#!/bin/bash
# Description: Search for the definition of the `invisible` class in all file types.

# Test: Find the definition of the `invisible` class.
rg '\.invisible\s*\{'

Length of output: 23

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.

None yet

3 participants