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: inert value in next15 #4491

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

Conversation

winchesHe
Copy link
Member

@winchesHe winchesHe commented Jan 4, 2025

Closes #

📝 Description

⛳️ Current behavior (updates)

🚀 New behavior

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

📝 Additional Information

Summary by CodeRabbit

  • Bug Fixes

    • Resolved an issue with the Tabs component in Next.js 15 environment
    • Improved version detection for Next.js and React compatibility
  • New Features

    • Added version checking utilities for Next.js and React
    • Enhanced getInertValue function with asynchronous version detection
  • Chores

    • Updated @nextui-org/shared-utils package with compatibility patch

@winchesHe winchesHe requested a review from jrgarciadev as a code owner January 4, 2025 09:03
Copy link

changeset-bot bot commented Jan 4, 2025

🦋 Changeset detected

Latest commit: 7b779e4

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

This PR includes changesets to release 58 packages
Name Type
@nextui-org/shared-utils Patch
@nextui-org/accordion Patch
@nextui-org/alert Patch
@nextui-org/autocomplete Patch
@nextui-org/avatar Patch
@nextui-org/badge Patch
@nextui-org/breadcrumbs Patch
@nextui-org/button Patch
@nextui-org/calendar Patch
@nextui-org/card Patch
@nextui-org/checkbox Patch
@nextui-org/chip Patch
@nextui-org/code Patch
@nextui-org/date-input Patch
@nextui-org/date-picker Patch
@nextui-org/divider Patch
@nextui-org/drawer Patch
@nextui-org/dropdown Patch
@nextui-org/form Patch
@nextui-org/image Patch
@nextui-org/input-otp Patch
@nextui-org/input Patch
@nextui-org/kbd Patch
@nextui-org/link Patch
@nextui-org/listbox Patch
@nextui-org/menu Patch
@nextui-org/modal Patch
@nextui-org/navbar Patch
@nextui-org/pagination Patch
@nextui-org/popover Patch
@nextui-org/progress Patch
@nextui-org/radio Patch
@nextui-org/ripple Patch
@nextui-org/scroll-shadow Patch
@nextui-org/select Patch
@nextui-org/skeleton Patch
@nextui-org/slider Patch
@nextui-org/snippet Patch
@nextui-org/spacer Patch
@nextui-org/spinner Patch
@nextui-org/switch Patch
@nextui-org/table Patch
@nextui-org/tabs Patch
@nextui-org/tooltip Patch
@nextui-org/user Patch
@nextui-org/theme Patch
@nextui-org/use-aria-button Patch
@nextui-org/use-aria-link Patch
@nextui-org/use-data-scroll-overflow Patch
@nextui-org/use-infinite-scroll Patch
@nextui-org/use-pagination Patch
@nextui-org/aria-utils Patch
@nextui-org/framer-utils Patch
@nextui-org/react-utils Patch
@nextui-org/react Patch
@nextui-org/system Patch
@nextui-org/use-image Patch
@nextui-org/use-real-shape 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 4, 2025

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

Name Status Preview Comments Updated (UTC)
nextui-docs-v2 ❌ Failed (Inspect) Jan 6, 2025 4:11pm
nextui-storybook-v2 ❌ Failed (Inspect) Jan 6, 2025 4:11pm

Copy link
Contributor

coderabbitai bot commented Jan 4, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This pull request addresses compatibility issues with the @nextui-org/shared-utils package, specifically focusing on the Tabs component and its behavior in Next.js 15. The changes introduce new utility functions to detect Next.js version and modify the getInertValue function to handle version-specific attribute handling. The modifications aim to resolve an issue related to the destroyInactiveTabPanel property and improve TypeScript type checking by removing a type ignore directive.

Changes

File Change Summary
.changeset/smart-eagles-hope.md Patch for @nextui-org/shared-utils package
packages/components/tabs/src/tab-panel.tsx Removed TypeScript ignore directive for inert attribute
packages/utilities/shared-utils/src/functions.ts - Added getNextVersion async function
- Added isNextJS15 async function
- Modified getInertValue to be async with version-specific logic

Sequence Diagram

sequenceDiagram
    participant App as Application
    participant NextUtils as Shared Utils
    participant NextJS as Next.js

    App->>NextUtils: Call getInertValue()
    NextUtils->>NextJS: Check Next.js version
    NextJS-->>NextUtils: Return version
    NextUtils->>NextUtils: Determine inert attribute
    NextUtils-->>App: Return inert value
Loading

Possibly related PRs

Suggested reviewers

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

linear bot commented Jan 4, 2025

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

🧹 Nitpick comments (3)
packages/utilities/shared-utils/src/functions.ts (2)

404-413: Consider using semver for robust version checks.
Dynamically importing next/package.json might introduce overhead and partial reliability issues if the version format changes. Relying on startsWith("15") in other parts of the code is also somewhat fragile. Using a semver library would provide a more resilient approach.


415-419: Handle minor & patch releases when identifying Next.js 15.
Using version.startsWith("15") might work for now, but it may fail to capture or properly handle any future minor/patch releases (e.g., 15.10.x). A semantic version check would be more maintainable long-term.

.changeset/smart-eagles-hope.md (1)

1-5: Enhance the patch description for clarity.
Consider adding more details about this fix, including how it impacts Tabs or addresses the Next.js 15 error, to help future maintainers and users understand the scope of the patch more readily.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a43b156 and 44d466e.

📒 Files selected for processing (3)
  • .changeset/smart-eagles-hope.md (1 hunks)
  • packages/components/tabs/src/tab-panel.tsx (0 hunks)
  • packages/utilities/shared-utils/src/functions.ts (2 hunks)
💤 Files with no reviewable changes (1)
  • packages/components/tabs/src/tab-panel.tsx

packages/utilities/shared-utils/src/functions.ts Outdated Show resolved Hide resolved
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.

2 participants