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.

Sign up for GitHub

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

Jump to bottom

[Documentation]: Backgrounds API documentation changes #30593

Open
jonniebigodes opened this issue Feb 19, 2025 · 0 comments
Open

[Documentation]: Backgrounds API documentation changes #30593

jonniebigodes opened this issue Feb 19, 2025 · 0 comments
Labels
documentation needs triage

Comments

@jonniebigodes
Copy link
Contributor

jonniebigodes commented Feb 19, 2025 •
edited
Loading

Describe the problem

With the 8.x release, the backgrounds addon introduced a new API for setting backgrounds, enabled via the backgroundsStoryGlobals option. This option allows users to configure backgrounds via the options object. With Storybook 9, the option will be removed in favor of the new API.

What needs to happen:

  • Update the documentation to reflect the new API for setting backgrounds
  • Remove any examples or references to the old API
  • Remove the backgroundsStoryGlobals option from the documentation (including the API reference)
  • Adjust the Migration guide to reflect the changes in the Backgrounds API
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation needs triage
Projects
Learning Team
Status: No status
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jonniebigodes