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(typescript): Allow React.FC in component and subcomponents properties #30718

Open
wants to merge 2 commits into
base: next
Choose a base branch
from

Conversation

yatishgoel
Copy link
Contributor

@yatishgoel yatishgoel commented Feb 28, 2025

Closes #30713

What I did

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Greptile Summary

This PR fixes TypeScript compatibility issues with React functional components in Storybook, specifically allowing React.FC in component and subcomponents properties of the meta object.

  • Modified code/renderers/react/src/preview.tsx to support React.FC<TArgs> as an alternative to ComponentType<TArgs> for the component property
  • Added support for React.FC<any> in the subcomponents record
  • Updated the Omit type to exclude 'component' and 'subcomponents' from the intersection with ComponentAnnotations
  • Resolves issue [Bug]: Problem with dot-notation subcomponents in meta #30713 where dot-notation components with React.FC type were causing TypeScript errors
  • Ensures proper type compatibility while maintaining existing functionality

💡 (2/5) Greptile learns from your feedback when you react with 👍/👎!

…ook's meta configuration.

This resolves type errors when using:
1. React.FC as the main component in meta.component
2. Components with specific prop types in meta.subcomponents
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

Copy link

nx-cloud bot commented Feb 28, 2025

View your CI Pipeline Execution ↗ for commit 562b89b.

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 1m 56s View ↗

☁️ Nx Cloud last updated this comment at 2025-02-28 12:48:20 UTC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Problem with dot-notation subcomponents in meta
3 participants