Addons: Update the Viewport and Background Addon #30841
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
…viewport addon to use modern globals. Clean up related documentation and types.
ndelangen
added
maintenance
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
LGTM
8 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
|
View your CI Pipeline Execution ↗ for commit 991d669.
☁️ Nx Cloud last updated this comment at |
…implify configuration by eliminating backgroundsStoryGlobals feature and related legacy tools. Update documentation accordingly.
…globals instead of parameters
… when set via globals, and ensure the toolbar is disabled accordingly.
…m/storybookjs/storybook into norbert/viewport-background-addon
…ated function type from styles, adjusted viewport configuration in Tool component, and added shorthand example in globals stories.
…t Tool component to handle new data structure.
…te globals stories to use a variable for viewport.
…g related components and stories for improved type safety and consistency.
There was a problem hiding this comment.
25 file(s) reviewed, 3 comment(s)
Edit PR Review Bot Settings | Greptile
ndelangen
added
ci:daily
…ion for addon viewport and backgrounds, and adjust formatting for consistency.
shilman
requested changes
Mar 19, 2025
valentinpalkovic
approved these changes
Mar 24, 2025
Co-authored-by: Valentin Palkovic <[email protected]>
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
This pull request includes significant changes to the
viewportaddon in Storybook, focusing on removing legacy code and simplifying the configuration. The most important changes include the removal of theviewportStoryGlobalsfeature flag, deletion of legacy code, and updates to the configuration and documentation.Removal of legacy code:
code/addons/viewport/src/legacy/ToolLegacy.tsx: EntireToolLegacycomponent removed, which included various functions and interfaces related to the viewport addon.code/addons/viewport/src/legacy/ViewportAddonParameter.ts: Removed theViewportAddonParameterinterface.Configuration updates:
code/.storybook/main.ts: RemovedviewportStoryGlobalsfrom thefeaturesconfiguration.code/addons/viewport/src/manager.tsx: Updated theaddons.registermethod to always useViewportTooland removed the conditional rendering ofViewportToolLegacy.code/addons/viewport/src/preview.ts: Simplified theinitialGlobalsexport by removing the legacy configuration.code/core/src/types/modules/core-common.ts: Removed theviewportStoryGlobalsfeature flag from theStorybookConfigRawinterface.Documentation updates:
docs/api/main-config/main-config-features.mdx: Removed the section describing theviewportStoryGlobalsfeature flag.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 modernizes the Viewport and Background addons by removing legacy implementations and standardizing configuration approaches for both addons.
ViewportToolLegacy,BackgroundSelectorLegacy, and related components, consolidating functionality into modern versionsviewportStoryGlobalsandbackgroundsStoryGlobalsfeature flags fromStorybookConfigRaw, making modern behavior the defaultConfigwith specificViewportParametersandBackgroundsParameterstypes