fix(components): popover closing issue in autocomplete with open modal #2494

wingkwong · 2024-03-10T13:14:08Z

📝 Description

revised shouldCloseOnInteractOutside in FreeSoloPopover
some people suggested to set allowsCustomValue to true. This could temporarily make the popover close because it makes the inputRef.current not to blur so that Autocomplete won't be re-rendered with isOpen = true. However, this won't blur the input if the selection is empty (i.e. it'll stay focused).

nextui/packages/components/autocomplete/src/use-autocomplete.ts

Lines 287 to 291 in 2894aec

    
           useEffect(() => { 
        
             if (!isOpen && !state.selectedItem && inputRef.current && !allowsCustomValue) { 
        
               inputRef.current.blur(); 
        
             } 
        
           }, [isOpen, allowsCustomValue]);

⛳️ Current behavior (updates)

The popover can't be closed with open modal. See the above issue #2475 for the demo.

🚀 New behavior

nextui-pr2494-demo.webm

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

No

📝 Additional Information

Summary by CodeRabbit

Bug Fixes
- Fixed an issue in the "@nextui-org/popover" package where the popover would incorrectly close when using autocomplete with an open modal.

…loPopover

changeset-bot · 2024-03-10T13:14:12Z

🦋 Changeset detected

Latest commit: aed650f

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

This PR includes changesets to release 5 packages

Name	Type
@nextui-org/popover	Patch
@nextui-org/autocomplete	Patch
@nextui-org/dropdown	Patch
@nextui-org/select	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

vercel · 2024-03-10T13:14:12Z

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	Mar 10, 2024 1:26pm

vercel · 2024-03-10T13:14:14Z

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

A member of the Team first needs to authorize it.

coderabbitai · 2024-03-10T13:14:14Z

Walkthrough

This update addresses a persistent issue found in the "@nextui-org/popover" package, specifically affecting the behavior of the FreeSoloPopover component within modals. The patch ensures the popover now properly closes when a user interacts outside of it, even when no item has been selected in the autocomplete component. This change directly targets and resolves issues reported by users experiencing difficulties with popover functionality in modal contexts.

Changes

File	Change Summary
`.changeset/four-turtles-move.md`	Introduces a patch fixing popover closing in autocomplete modals.
`.../components/popover/src/free-solo-popover.tsx`	Updated logic to always return `false` for outside interactions.

Assessment against linked issues

Objective	Addressed	Explanation
Fix the issue where the Autocomplete popover does not close on click outside in a modal (#2475, #2082)	✅
Ensure the popover can be closed by clicking outside, without selecting an item (#1987)	✅

Poem

In a field of code, under the moon's soft glow,
A rabbit hopped, with fixes in tow.
🌙✨🐇💻
"No more shall popovers stubbornly stay,
In modals, they'll close, come what may."
With a click outside, they now obey,
A patch, a leap, a brighter day.

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-tests 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 tests 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 tests.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@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.
The JSON schema for the configuration file is available here.
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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

…n modal

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 2894aec and aed650f.

Files selected for processing (2)

.changeset/four-turtles-move.md (1 hunks)
packages/components/popover/src/free-solo-popover.tsx (1 hunks)

Additional comments: 2

.changeset/four-turtles-move.md (1)

1-5: The changeset provides a clear indication of the patch update for the "@nextui-org/popover" package and succinctly describes the fix. However, it would be beneficial for users and developers if the description included more details about the specific changes made and how it impacts the functionality or usage of the Autocomplete component within modals. This additional information can help in understanding the context and significance of the update more thoroughly.

packages/components/popover/src/free-solo-popover.tsx (1)

78-78: The update to the shouldCloseOnInteractOutside function to always return false is a direct approach to fixing the issue with the popover not closing when interacting outside of it in a modal context. This change appears to address the problem effectively. However, it's important to verify that this adjustment does not inadvertently affect other use cases of the FreeSoloPopover component where closing the popover on outside interactions might still be desired. Testing or reviewing usage scenarios outside of the modal context would be beneficial to ensure that this change does not introduce new issues.

jrgarciadev

Thank you! @wingkwong 🙏🏻

Tosters · 2024-04-06T10:49:59Z

Still broken. Are there any workarounds?

msedge_YZP0QasQj7.mp4

browsers:
Edge: Version 122.0.2365.113 (Official build) stable app, extended channel (64-bit)
Chrome: Version 122.0.6261.156 (Official Build) extended (64-bit)

package.json:

"dependencies": {
    "@heroicons/react": "^2.1.3",
    "@nextui-org/react": "^2.2.10",
    "@reduxjs/toolkit": "^2.2.3",
    "firebase": "^10.10.0",
    "framer-motion": "^11.0.24",
    "next-themes": "^0.3.0",
    "react": "^18.2.0",
    "react-dom": "^18.2.0",
    "react-redux": "^9.1.0",
    "react-router-dom": "^6.22.3",
    "react-use-wizard": "^2.3.0"
  },
  "devDependencies": {
    "@types/react": "^18.2.74",
    "@types/react-dom": "^18.2.23",
    "@typescript-eslint/eslint-plugin": "^7.5.0",
    "@typescript-eslint/parser": "^7.5.0",
    "@vitejs/plugin-react": "^4.2.1",
    "autoprefixer": "^10.4.19",
    "eslint": "^8.57.0",
    "eslint-plugin-react-hooks": "^4.6.0",
    "eslint-plugin-react-refresh": "^0.4.6",
    "openapi-typescript": "^6.7.5",
    "postcss": "^8.4.38",
    "tailwindcss": "^3.4.3",
    "typescript": "^5.4.3",
    "vite": "^5.2.7"
  }

wingkwong · 2024-04-06T11:52:46Z

@Tosters We haven't released that yet - it should be in the next release.

Hervinho · 2024-04-12T16:34:22Z

@wingkwong when is the next release?

wingkwong · 2024-04-12T16:36:33Z

@Hervinho target on April 15. See here.

matteogilioli · 2024-04-17T08:56:52Z

I updated to the latest version and it still seems broken

fix(components): set shouldCloseOnInteractOutside to false for FreeSo…

ac3b5fd

…loPopover

vercel bot deployed to Preview – nextui-storybook-v2 March 10, 2024 13:16 View deployment

feat(changeset): fixed popover closing issue in autocomplete with ope…

aed650f

…n modal

wingkwong marked this pull request as ready for review March 10, 2024 13:25

wingkwong requested a review from jrgarciadev as a code owner March 10, 2024 13:25

vercel bot deployed to Preview – nextui-storybook-v2 March 10, 2024 13:26 View deployment

coderabbitai bot reviewed Mar 10, 2024

View reviewed changes

jrgarciadev approved these changes Mar 10, 2024

View reviewed changes

jrgarciadev merged commit a05aef0 into nextui-org:main Mar 10, 2024
7 of 8 checks passed

github-actions bot mentioned this pull request Mar 10, 2024

ci(changesets): 📦 version packages #2441

Merged

wingkwong mentioned this pull request Mar 12, 2024

[BUG] - The autocomplete component does not work within the modal component. #2510

Closed

github-actions bot mentioned this pull request Mar 13, 2024

ci(changesets): 📦 version packages hoanghohotel/nextui#4

Open

wingkwong mentioned this pull request Mar 17, 2024

fix: revise shouldCloseOnInteractOutside for FreeSoloPopover #2536

Merged

Tosters mentioned this pull request Apr 6, 2024

[BUG] - Auto Complete popover does not close without make selection in modal #2247

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(components): popover closing issue in autocomplete with open modal #2494

fix(components): popover closing issue in autocomplete with open modal #2494

wingkwong commented Mar 10, 2024 •

edited

changeset-bot bot commented Mar 10, 2024 •

edited

vercel bot commented Mar 10, 2024 •

edited

vercel bot commented Mar 10, 2024

coderabbitai bot commented Mar 10, 2024 •

edited

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

coderabbitai bot left a comment

jrgarciadev left a comment

Tosters commented Apr 6, 2024

wingkwong commented Apr 6, 2024

Hervinho commented Apr 12, 2024

wingkwong commented Apr 12, 2024

matteogilioli commented Apr 17, 2024

	useEffect(() => {
	if (!isOpen && !state.selectedItem && inputRef.current && !allowsCustomValue) {
	inputRef.current.blur();
	}
	}, [isOpen, allowsCustomValue]);

fix(components): popover closing issue in autocomplete with open modal #2494

fix(components): popover closing issue in autocomplete with open modal #2494

Conversation

wingkwong commented Mar 10, 2024 • edited

📝 Description

⛳️ Current behavior (updates)

🚀 New behavior

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

📝 Additional Information

Summary by CodeRabbit

changeset-bot bot commented Mar 10, 2024 • edited

🦋 Changeset detected

vercel bot commented Mar 10, 2024 • edited

vercel bot commented Mar 10, 2024

coderabbitai bot commented Mar 10, 2024 • edited

Walkthrough

Changes

Assessment against linked issues

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

jrgarciadev left a comment

Choose a reason for hiding this comment

Tosters commented Apr 6, 2024

wingkwong commented Apr 6, 2024

Hervinho commented Apr 12, 2024

wingkwong commented Apr 12, 2024

matteogilioli commented Apr 17, 2024

wingkwong commented Mar 10, 2024 •

edited

changeset-bot bot commented Mar 10, 2024 •

edited

vercel bot commented Mar 10, 2024 •

edited

coderabbitai bot commented Mar 10, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)