fix(autocomplete): empty items with allowCustomValue

[wingkwong]

Closes #2554

📝 Description

In useComboBox.ts, when state.isOpen, it will pass input ref and popover ref to ariaHideOutside, where the error was thrown. If we have autocomplete with empty items + allowCustomValue, when we open the popover, the ref will be null causing the issue.

ref: useComboBox.ts#L321 and ariaHideOutside.ts#L112

⛳️ Current behavior (updates)

Autocomplete with empty items + allowCustomValue -> open popover -> see the error

import.mjs:1290 Uncaught TypeError: Cannot read properties of null (reading 'contains')
    at eval (import.mjs:1290:33)
    at Array.some (<anonymous>)
    at MutationObserver.eval (import.mjs:1290:15)

🚀 New behavior

No error is shown

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

📝 Additional Information

Summary by CodeRabbit

• Bug Fixes

  • Patched the "@nextui-org/autocomplete" package to fix an issue where empty items with allowCustomValue would not render properly due to a null node problem.

• New Features

  • Enhanced the Autocomplete component to render an empty div when there are no suggestions, improving the user interface.

[linear]

ENG-530 [BUG] - AutoComplete error when items is an empty array

[changeset-bot]

🦋 Changeset detected

Latest commit: a926914

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/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

[coderabbitai]

Walkthrough

This update addresses a bug in the @nextui-org/autocomplete package where an error occurred if the autocomplete items array was empty. To resolve this, a new function getEmptyPopoverProps has been introduced to ensure that an empty div is rendered when there are no suggestions, improving the user interface and preventing null node errors related to ariaHideOutside from @react-aria/overlays.

Changes

File Path	Change Summary
.../autocomplete/src/autocomplete.tsx	Added getEmptyPopoverProps to render an empty div for empty suggestions.
.../autocomplete/src/use-autocomplete.ts	Introduced getEmptyPopoverProps function to return properties for handling empty suggestions.
.changeset/chatty-singers-remember.md	Patch notes for fixing empty items issue with allowCustomValue by addressing a null node issue.

Assessment against linked issues

Objective	Addressed	Explanation
Fix AutoComplete error when items array is empty (#2554)	✅

---

Recent Review Status

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between ebab108 and a926914.

Files selected for processing (3)

• .changeset/chatty-singers-remember.md (1 hunks)
• packages/components/autocomplete/src/autocomplete.tsx (2 hunks)
• packages/components/autocomplete/src/use-autocomplete.ts (2 hunks)

Additional comments not posted (4)

.changeset/chatty-singers-remember.md (1)

1-5: The changeset description is clear and accurately reflects the changes made in this pull request. Good job on providing a concise yet informative summary.

packages/components/autocomplete/src/autocomplete.tsx (2)

29-29: The addition of getEmptyPopoverProps is a well-thought-out solution to handle empty suggestions gracefully. Good job on enhancing the user experience.

---

46-48: Rendering an empty div when there are no suggestions is a clean and effective way to avoid errors related to null nodes. This change improves the robustness of the component.

packages/components/autocomplete/src/use-autocomplete.ts (1)

403-409: The implementation of getEmptyPopoverProps in the useAutocomplete hook is a smart way to handle the null node issue. This addition enhances the component's error handling capabilities.

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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.

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

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
nextui-docs-v2	✅ Ready (Inspect)	Visit Preview	Apr 9, 2024 3:02pm
nextui-storybook-v2	✅ Ready (Inspect)	Visit Preview	Apr 9, 2024 3:02pm