Skip to content

fix(system-rsc): extendVariants typescript type#4291

Merged
wingkwong merged 4 commits into
heroui-inc:canaryfrom
shlyamster:fix/react-types
Dec 11, 2024
Merged

fix(system-rsc): extendVariants typescript type#4291
wingkwong merged 4 commits into
heroui-inc:canaryfrom
shlyamster:fix/react-types

Conversation

@shlyamster
Copy link
Copy Markdown
Contributor

@shlyamster shlyamster commented Dec 9, 2024

Closes #4269

📝 Description

This request solves the problem of the data type returned by the extendVariants function.

⛳️ Current behavior (updates)

In the current implementation, the result of the extendVariants function is the ForwardRefRenderFunction data type.

🚀 New behavior

Because the resolution of the function is forwardRef, therefore it is necessary to return the ForwardRefExoticComponent data type.

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

These changes work with react/types versions 18 and 19. And they don't break backward compatibility.

Summary by CodeRabbit

  • New Features
    • Enhanced type definitions for components, improving clarity and type safety.
    • Updated ExtendVariants type to streamline props structure.
  • Bug Fixes
    • Corrected the return type of the extendVariants function to ensure it meets expected standards.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Dec 9, 2024

🦋 Changeset detected

Latest commit: 53a16f2

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

This PR includes changesets to release 35 packages
Name Type
@nextui-org/system-rsc Patch
@nextui-org/code Patch
@nextui-org/divider Patch
@nextui-org/kbd Patch
@nextui-org/spacer Patch
@nextui-org/spinner Patch
@nextui-org/system Patch
@nextui-org/react Patch
@nextui-org/accordion Patch
@nextui-org/listbox Patch
@nextui-org/menu Patch
@nextui-org/table Patch
@nextui-org/autocomplete Patch
@nextui-org/button Patch
@nextui-org/select Patch
@nextui-org/alert Patch
@nextui-org/calendar Patch
@nextui-org/checkbox Patch
@nextui-org/date-input Patch
@nextui-org/date-picker Patch
@nextui-org/drawer Patch
@nextui-org/dropdown Patch
@nextui-org/form Patch
@nextui-org/input-otp Patch
@nextui-org/input Patch
@nextui-org/modal Patch
@nextui-org/navbar Patch
@nextui-org/popover Patch
@nextui-org/radio Patch
@nextui-org/slider Patch
@nextui-org/snippet Patch
@nextui-org/tabs Patch
@nextui-org/tooltip Patch
@nextui-org/aria-utils Patch
@nextui-org/framer-utils 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
Copy link
Copy Markdown

vercel Bot commented Dec 9, 2024

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 Dec 9, 2024 2:47pm
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 9, 2024 2:47pm

@vercel
Copy link
Copy Markdown

vercel Bot commented Dec 9, 2024

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

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Dec 9, 2024

Walkthrough

The changes in this pull request focus on updating type declarations in the extend-variants.d.ts file. The import of ForwardRefRenderFunction has been replaced with ForwardRefExoticComponent, and new types PropsWithoutRef and RefAttributes have been introduced. The ExtendVariants type's return type has been modified to utilize PropsWithoutRef, improving the clarity of the props structure while retaining the ability to handle refs.

Changes

File Path Change Summary
packages/core/system-rsc/src/extend-variants.d.ts Updated type definitions: replaced ForwardRefRenderFunction with ForwardRefExoticComponent, added PropsWithoutRef and RefAttributes, and modified ExtendVariants return type accordingly.
.changeset/twelve-ducks-thank.md Minor version update for @nextui-org/system-rsc and corrected return type of extendVariants function.

Assessment against linked issues

Objective Addressed Explanation
Ensure extendVariants can be used as a JSX component (#4269)

Possibly related PRs

Suggested reviewers

  • jrgarciadev

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f88b039 and 53a16f2.

📒 Files selected for processing (1)
  • .changeset/twelve-ducks-thank.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .changeset/twelve-ducks-thank.md

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 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
Copy Markdown
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

🧹 Outside diff range and nitpick comments (1)
.changeset/twelve-ducks-thank.md (1)

5-5: Enhance the changeset description for better clarity

The description could be more informative about the specific changes and their impact.

Consider expanding the description like this:

-Fix data type returned by the extendVariants function (#4269)
+Fix data type returned by the extendVariants function from ForwardRefRenderFunction to ForwardRefExoticComponent for React 18/19 compatibility (#4269)
🧰 Tools
🪛 LanguageTool

[uncategorized] ~5-~5: You might be missing the article “the” here.
Context: ...@nextui-org/system-rsc": minor --- Fix data type returned by the extendVariants fun...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 77c5ac4 and f88b039.

📒 Files selected for processing (1)
  • .changeset/twelve-ducks-thank.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
.changeset/twelve-ducks-thank.md

[uncategorized] ~5-~5: You might be missing the article “the” here.
Context: ...@nextui-org/system-rsc": minor --- Fix data type returned by the extendVariants fun...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

🔇 Additional comments (1)
.changeset/twelve-ducks-thank.md (1)

1-3: LGTM: Version bump is appropriate

The minor version bump is correct as this changes type definitions in a backward-compatible way.

@jrgarciadev
Copy link
Copy Markdown
Member

@wingkwong please review & check

macci001 pushed a commit that referenced this pull request Dec 17, 2024
* fix: ReactElement type

* fix: extendVariants forwardRef return type

* feat: add changeset

* chore(changeset): change to patch

---------

Co-authored-by: աӄա <wingkwong.code@gmail.com>
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] - Component created from extendVariants cannot be used as a JSX component

3 participants