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(tooltip): accessing element.ref was removed in React 19 issue #4531

Open
wants to merge 1 commit into
base: canary
Choose a base branch
from

Conversation

wingkwong
Copy link
Member

@wingkwong wingkwong commented Jan 10, 2025

Closes #4526

📝 Description

As titled. Applied the same fix as 3f9e0ff.

⛳️ Current behavior (updates)

image

🚀 New behavior

No such error

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

No

📝 Additional Information

Summary by CodeRabbit

  • Bug Fixes
    • Updated @nextui-org/tooltip package to resolve a ref access issue in React 19
    • Improved Tooltip component's ref handling to ensure compatibility with newer React versions

@wingkwong wingkwong added this to the v2.6.12 milestone Jan 10, 2025
Copy link

linear bot commented Jan 10, 2025

Copy link

changeset-bot bot commented Jan 10, 2025

🦋 Changeset detected

Latest commit: 6a16b99

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

This PR includes changesets to release 4 packages
Name Type
@nextui-org/tooltip Patch
@nextui-org/slider Patch
@nextui-org/snippet 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 Jan 10, 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 10, 2025 0:45am
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 10, 2025 0:45am

Copy link
Contributor

coderabbitai bot commented Jan 10, 2025

Walkthrough

A patch has been introduced for the @nextui-org/tooltip package to address a React 19 compatibility issue related to accessing element.ref. The change modifies how the ref is retrieved when cloning child elements, introducing a fallback mechanism that first checks the child's props for a ref and then falls back to accessing the ref directly from the element. This ensures compatibility with React 19's changes to ref handling.

Changes

File Change Summary
packages/components/tooltip/src/tooltip.tsx Modified ref access logic when cloning child elements
.changeset/great-feet-lay.md Patch version update for @nextui-org/tooltip

Assessment against linked issues

Objective Addressed Explanation
Fix NextJS error related to element.ref [#4526]

Possibly related PRs

Suggested reviewers

  • jrgarciadev

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.

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
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eada8cb and 6a16b99.

📒 Files selected for processing (2)
  • .changeset/great-feet-lay.md (1 hunks)
  • packages/components/tooltip/src/tooltip.tsx (1 hunks)
🔇 Additional comments (1)
.changeset/great-feet-lay.md (1)

1-5: LGTM! Changeset is properly configured.

The changeset correctly:

  • Uses patch version bump for backward-compatible fix
  • References the issue number
  • Provides clear context about the React 19 compatibility change

Comment on lines +51 to +55
// Accessing the ref from props, else fallback to element.ref
// https://github.com/facebook/react/pull/28348
const childRef = child.props.ref ?? (child as any).ref;

trigger = cloneElement(child, getTriggerProps(child.props, childRef));
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Update needed: Similar ref handling change required in popover-trigger

The same React 19 compatibility update is needed in:

  • packages/components/popover/src/popover-trigger.tsx

The other instances of .ref usage in the codebase are using different patterns and are safe.

🔗 Analysis chain

LGTM! The ref handling change looks correct.

The implementation properly handles the React 19 changes by:

  1. First attempting to access ref from props (new React way)
  2. Falling back to element.ref (backward compatibility)
  3. Including a reference to the relevant React PR

This change ensures compatibility while maintaining backward support.

Let's verify there are no other instances of direct ref access that need similar updates:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for potential direct ref access patterns
rg -g '*.{tsx,ts,jsx,js}' '\.(ref)\b(?!\s*\?\?)'

Length of output: 283


Script:

#!/bin/bash
# Search for .ref access patterns with simpler regex
echo "=== Searching with ripgrep ==="
rg -g '*.{tsx,ts,jsx,js}' '\.ref\b'

echo -e "\n=== Searching with ast-grep ==="
# Look for property access patterns with 'ref'
ast-grep --pattern 'PropertyAccess {
  object: $_,
  property: "ref"
}'

Length of output: 1191

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] - Slider put a NextJS error
1 participant