Core: Allow empty render functions in CSF factories #30565
Conversation
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
3 file(s) reviewed, 3 comment(s)
Edit PR Review Bot Settings | Greptile
| // @ts-expect-error disabled not provided ❌ | ||
| const Basic = meta.story({ | ||
| args: { | ||
| label: 'good', | ||
| }, | ||
| render: (args) => <div>Hello world</div>, | ||
| }); |
There was a problem hiding this comment.
logic: This test case has a potential issue - it's marked as expecting a type error for missing 'disabled' prop, but the render function doesn't actually use the args parameter, so it should be allowed to omit required props like the empty render case above
| story< | ||
| TInput extends StoryAnnotations<ReactRenderer, Context['args']> & { | ||
| render: () => ReactRenderer['storyResult']; | ||
| }, | ||
| >( | ||
| story: TInput | ||
| ): ReactStory; |
There was a problem hiding this comment.
logic: The new overload is more specific than the existing one and should be placed after the more general overload to ensure proper type inference. Consider swapping the order of these overloads.
| story< | |
| TInput extends StoryAnnotations<ReactRenderer, Context['args']> & { | |
| render: () => ReactRenderer['storyResult']; | |
| }, | |
| >( | |
| story: TInput | |
| ): ReactStory; | |
| story< | |
| const TInput extends Simplify< | |
| StoryAnnotations< | |
| ReactRenderer, | |
| // TODO: infer mocks from story itself as well | |
| AddMocks<Context['args'], MetaInput['args']>, | |
| SetOptional<Context['args'], keyof Context['args'] & keyof MetaInput['args']> | |
| > | |
| >, | |
| >( | |
| story: TInput | |
| ): ReactStory; | |
| story< | |
| TInput extends StoryAnnotations<ReactRenderer, Context['args']> & { | |
| render: () => ReactRenderer['storyResult']; | |
| }, | |
| >( | |
| story: TInput | |
| ): ReactStory; |
| TInput extends StoryAnnotations<ReactRenderer, Context['args']> & { | ||
| render: () => ReactRenderer['storyResult']; | ||
| }, |
There was a problem hiding this comment.
style: The constraint render: () => ReactRenderer['storyResult'] forces the render function to take no arguments, which may be too restrictive. Consider allowing optional args parameter.
|
View your CI Pipeline Execution ↗ for commit b5aa1f2.
☁️ Nx Cloud last updated this comment at |
shilman
changed the title
Closes #
What I did
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake 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/coreteam 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 introduces type system improvements for handling empty render functions in CSF4 (Component Story Format 4) for Storybook's React renderer.
ReactMetainterface to handle empty render functions without requiring argscsf-factories.test.tsxto verify empty render function behaviordefineStoryfunction betweenComponentAnnotationsandStoryAnnotations