-
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
Addons: Fix preview import examples #32232
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
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
8 files reviewed, no comments
|
View your CI Pipeline Execution ↗ for commit 568fc7e
☁️ Nx Cloud last updated this comment at |
kylegach
approved these changes
Aug 11, 2025
Contributor
kylegach
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
This was referenced Aug 11, 2025
Merged
ndelangen
pushed a commit
that referenced
this pull request
Aug 20, 2025
…pets Docs: Fix preview examples imports (cherry picked from commit 7e7e513)
ndelangen
pushed a commit
that referenced
this pull request
Aug 21, 2025
…pets Docs: Fix preview examples imports (cherry picked from commit 7e7e513)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
ci:docs
Run the CI jobs for documentation checks only.
documentation
patch:done
Patch/release PRs already cherry-picked to main/release branch
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Follows up on #31930
What I did
With this pull request, the examples referencing preview files were updated to provide the correct type imports to align with the rest of the documentation.
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 fixes TypeScript import syntax in Storybook documentation snippets by standardizing the use of explicit type imports. The changes update
import { Preview } from '@storybook/your-framework'toimport type { Preview } from '@storybook/your-framework'across 8 documentation files in thedocs/_snippets/directory.The affected files include preview configuration examples for various Storybook features and addons:
This change aligns with TypeScript best practices for type-only imports, which provide several benefits: they make the intent explicit that imports are used solely for type annotations, allow TypeScript to optimize builds by stripping these imports during compilation, and improve semantic clarity by distinguishing between runtime dependencies and compile-time types.
The modification is part of a broader effort to ensure consistency across all Storybook documentation examples and follows up on issue #31930. Since the
Previewinterface is only used for type annotation (const preview: Preview = { ... }), it should be imported as a type rather than a value. This change maintains full functional equivalence while demonstrating the recommended TypeScript patterns to users copying these examples.Confidence score: 5/5