storybookjs / storybook

Storybook is the industry standard workshop for building, documenting, and testing UI components in isolation
https://storybook.js.org
MIT License
83.8k stars 9.18k forks source link

🧩 Storybook 8 community addon outreach #26031

Open joevaugh4n opened 6 months ago

joevaugh4n commented 6 months ago

With Storybook 8 coming soon, we’ve created an addon migration guide to summarize the important changes for addon creators. Please note that not all addons will be affected by breaking changes introduced in Storybook 8, but all addon creators are encouraged to review the latest changes and assess their addons for compatibility.

FAQs

I'm maintaining an addon. How do I make it compatible with Storybook 8?

We highly recommend consulting our addon migration guide. If you have any questions or encounter any issues, please reach out to Storybook maintainers in the Storybook Discord community.

What can I do if an addon I use is incompatible with Storybook 8 but isn't on this list?

To share incompatibility errors, please open an issue on the repo of the relevant addon, asking the author to add Storybook 8 compatibility, and share this page for reference.

It's also really useful for us to know which addons aren't yet compatible. Please consider adding a comment here, especially if the addon is popular and causes a critical failure. Alternatively, if you have the resources, please consider helping migrate that addon yourself!

Thank you for being part of our addon community! 🙇

Most downloaded community addons

We will use this list to track outreach to the maintainers of these most downloaded community addons.

### Community Addon outreach
- [x] **msw-storybook-addon** ([repo](https://github.com/mswjs/msw-storybook-addon))
- [x] **storybook-dark-mode** 👉🏼 https://github.com/hipstersmoothie/storybook-dark-mode/issues/250 ready to go
- [x] **storybook-addon-mock** ([repo](https://github.com/nutboltu/storybook-addon-mock)) 👉🏼 https://github.com/linearlabs-workspace/storybook-addon-mock/issues/208
- [x] **storybook-i18n** ([repo](https://github.com/stevensacks/storybook-i18n)) 👉🏼 https://github.com/stevensacks/storybook-i18n/issues/20
- [x] **storybook-addon-remix-react-router** ([repo](https://github.com/JesusTheHun/storybook-addon-remix-react-router)) 👉🏼 https://github.com/JesusTheHun/storybook-addon-react-router-v6/issues/62
- [x] **storybook-react-i18next** ([repo](https://github.com/stevensacks/storybook-react-i18next)) 👉🏼 _Reached out on Discord_
- [ ] **storybook-addon-swc** ([repo](https://github.com/Karibash/storybook-addon-swc)) 👉🏼 https://github.com/Karibash/storybook-addon-swc/issues/53
- [x] **storybook-addon-apollo-client** ([repo](https://github.com/lifeiscontent/storybook-addon-apollo-client)) 👉🏼 https://github.com/lifeiscontent/storybook-addon-apollo-client/issues/105
- [x] **storycrawler** ([repo](https://github.com/reg-viz/storycap)) 👉🏼 https://github.com/reg-viz/storycap/issues/838
- [x] **storycap** ([repo](https://github.com/reg-viz/storycap)) 👉🏼 https://github.com/reg-viz/storycap/issues/838
- [ ] **storybook-addon-performance** ([repo](https://github.com/atlassian-labs/storybook-addon-performance)) 👉🏼 https://github.com/atlassian-labs/storybook-addon-performance/issues/152
- [x] **@chakra-ui/storybook-addon** ([repo](https://github.com/chakra-ui/chakra-ui)) 👉🏼 https://github.com/chakra-ui/chakra-ui/discussions/8306
- [x] **@storybook/addon-react-native-web** ([repo](https://github.com/storybookjs/addon-react-native-web)) 👉🏼 _Reached out via Discord_
- [x] **loki** ([repo](https://github.com/oblador/loki)) 👉🏼 https://github.com/oblador/loki/issues/503
- [ ] **storybook-addon-cookie** ([repo](https://github.com/hwookim/storybook-addon-cookie)) 👉🏼 https://github.com/hwookim/storybook-addon-cookie/issues/10
- [ ] **@geometricpanda/storybook-addon-badges** ([repo](https://github.com/geometricpanda/storybook-addon-badges)) 👉🏼 https://github.com/geometricpanda/storybook-addon-badges/issues/20
- [x] **@react-theming/storybook-addon** 👉🏼 https://github.com/react-theming/storybook-addon/issues/87
- [x] **@etchteam/storybook-addon-status** ([repo](https://github.com/etchteam/storybook-addon-status)) 👉🏼 https://github.com/etchteam/storybook-addon-status/issues/57
- [x] **storybook-vue3-router** ([repo](https://github.com/NickMcBurney/storybook-vue3-router)) 👉🏼https://github.com/NickMcBurney/storybook-vue3-router/issues/61
- [x] **storybook-addon-sass-postcss** ([repo](https://github.com/0xTheProDev/storybook-addon-sass-postcss)) 👉🏼 https://github.com/0xTheProDev/storybook-addon-sass-postcss/issues/9
- [x] **storybook-design-token** ([repo](https://github.com/UX-and-I/storybook-design-token)) 👉🏼 https://github.com/UX-and-I/storybook-design-token/issues/206
- [x] **storybook-addon-react-docgen** ([repo](https://github.com/hipstersmoothie/storybook-addon-react-docgen)) 👉🏼 https://github.com/hipstersmoothie/storybook-addon-react-docgen/issues/142
- [x] **@whitespace/storybook-addon-html** ([repo](https://github.com/whitespace-se/storybook-addon-html)) 👉🏼 https://github.com/whitespace-se/storybook-addon-html/issues/112
- [x] **storybook-react-intl** ([repo](https://github.com/stevensacks/storybook-react-intl)) 👉🏼 _Reached out on Discord_
- [x] **storybook-addon-angular-router** ([repo](https://github.com/Jakob-em/storybook-addon-angular-router)) 👉🏼 https://github.com/Jakob-em/storybook-addon-angular-router/issues/27
- [ ] **storybook-zeplin** ([repo](https://github.com/mertkahyaoglu/storybook-zeplin)) 👉🏼 https://github.com/zeplin/storybook-zeplin/issues/84
- [ ] **storybook-addon-paddings** ([repo](https://github.com/rbardini/storybook-addon-paddings)) 👉🏼 https://github.com/rbardini/storybook-addon-paddings/issues/42
- [ ] **@amplitude/storybook-addon-amplitude** ([repo](https://github.com/amplitude/storybook-addon-amplitude)) 👉🏼 https://github.com/amplitude/storybook-addon-amplitude/issues/53
- [ ] **@bbbtech/storybook-formik** ([repo](https://github.com/bbbtech/storybook-formik)) 👉🏼 https://github.com/bbbtech/storybook-formik/issues/75
- [x] **storybook-addon-rtl** ([repo](https://github.com/literalpie/storybook-addon-rtl)) 👉🏼 https://github.com/literalpie/storybook-addon-rtl/issues/8
- [x] **storybook-addon-code-editor** ([repo](https://github.com/JeremyRH/storybook-addon-code-editor)) 👉🏼 https://github.com/JeremyRH/storybook-addon-code-editor/issues/33
- [ ] **storybook-addon-manual-mocks** ([repo](https://github.com/gebeto/storybook-addon-manual-mocks)) 👉🏼 https://github.com/gebeto/storybook-addon-manual-mocks/issues/17
- [ ] **storybook-xstate-addon** ([repo](https://github.com/simeonc/storybook-xstate-addon)) 👉🏼 https://github.com/SimeonC/storybook-xstate-addon/issues/59
- [x] **storybook-addon-intl** ([repo](https://github.com/truffls/storybook-addon-intl)) 👉🏼 https://github.com/truffls/storybook-addon-intl/issues/184
- [ ] **storybook-tailwind-dark-mode** ([repo](https://github.com/renatomoor/storybook-tailwind-dark-mode)) 👉🏼 https://github.com/renatomoor/storybook-tailwind-dark-mode/issues/24
SalahAdDin commented 5 months ago

@joevaugh4n storybook-addon-rtl (repo) is compatible.

JesusTheHun commented 5 months ago

@joevaugh4n storybook-addon-react-router-v6 (repo) is compatible.

Note that the addon has been renamed storybook-addon-remix-react-router 👏

joevaugh4n commented 5 months ago

@JesusTheHun, @SalahAdDin, thanks so much both!

pcorpet commented 5 months ago

I see that storybook-addon-theme-provider is not on the list. I'll reach out to the maintainer.

indigolain commented 5 months ago

@joevaugh4n storycrawler (repo) and storycap (repo) is now compatible 🚀

gentslava commented 5 months ago

@joevaugh4n hello I prepared a PR for @bbbtech/storybook-formik I also published a fork with Storybook 8 compatibility @gentslava/storybook-formik You can include the fork if the original author doesn't add compatibility.

maraisr commented 5 months ago

@joevaugh4n storybook-addon-grid is now Storybook 8 compatible. ^0.5.0

darkvertex commented 5 months ago

What about addons made by the Storybook devs?

For example @storybook/addon-events@6.2.9 from https://github.com/storybookjs/storybook/tree/master/addons/events reports as incompatible when starting the Storybook dev server

simon-v-swyftx commented 4 months ago

Bug opened for storybook-addon-playroom https://github.com/rbardini/storybook-addon-playroom/issues/56

SalahAdDin commented 4 months ago

Bug opened for storybook-addon-playroom rbardini/storybook-addon-playroom#56

That addon looks interesting.

gethari commented 4 months ago

@ljcl/storybook-addon-cssprops -> https://github.com/ljcl/storybook-addon-cssprops/issues/45#issuecomment-2003340951

julrich commented 4 months ago

We're currently working on updating our addons, should be done by next week:

lifeiscontent commented 4 months ago

@joevaugh4n is there a way I can use a React Provider across preview/manager one of the biggest pain points for zero config setup in storybook-addon-apollo-client is because the deps between preview/manager are not the same, so when users try to run the addon the Provider breaks due to it using different dependencies with the decorators are injected into preview. I've had to make an API where users have to manually pass in the MockedProvider to get this to work

ZvjezdanavisosevicAgronod commented 2 months ago

The following packages are incompatible with Storybook 8.1.6 as they depend on different major versions of Storybook packages: WARN - storybook-addon-material-ui@0.9.0-alpha.24 WARN Repo: https://github.com/react-theming/storybook-addon-material-ui WARN - storybook-addon-material-ui5@1.0.0 WARN Repo: https://github.com/alexpanov/storybook-addon-material-ui

any fixes available here?

mansiohrey commented 2 months ago

The following packages are incompatible with Storybook 8.1.6 as they depend on different major versions of Storybook packages: WARN - storybook-addon-sass-postcss@0.2.0

any fix here?

amir-e-uidb commented 1 month ago

what about Typescript anything new that i should know of?