Docs: Fix type import in background code snippet#31930
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
LGTM
1 file reviewed, no comments
Edit PR Review Bot Settings | Greptile
jonniebigodes
requested changes
Jul 2, 2025
Contributor
jonniebigodes
left a comment
There was a problem hiding this comment.
@tijmenb, thanks for putting together this pull request and helping us improve the documentation by catching this minor issue with the example. Appreciate it 🙏
Left one small item for you to address when you can.
Let me know once you've addressed it, and gladly merge it.
Hope you have a fantastic day.
Stay safe
|
View your CI Pipeline Execution ↗ for commit e87b871.
☁️ Nx Cloud last updated this comment at |
Co-authored-by: jonniebigodes <joaocontadesenvolvimento@gmail.com>
jonniebigodes
approved these changes
Jul 3, 2025
Contributor
|
@tijmenb thanks for addressing the feedback so promptly. Appreciate it 🙏 ! I'll gladly merge this once the checklist clears. Have a fantastic day. |
This was referenced Jul 3, 2025
Merged
ghengeveld
pushed a commit
that referenced
this pull request
Jul 8, 2025
Docs: Fix type import in background code snippet (cherry picked from commit cb315cb)
8 tasks
Merged
17 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What I did
Update the docs for https://storybook.js.org/docs/essentials/backgrounds
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
storiesunit testsintegration testsend-to-end testsManual testing
Make sure the snippet works out of the box.
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
Updates the TypeScript import syntax in the backgrounds configuration documentation snippet to use explicit type imports.
import { Preview } from '@storybook/your-framework'toimport { type Preview } from '@storybook/your-framework'indocs/_snippets/addon-backgrounds-options-in-preview.md