search

storybookjs / storybook

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

[Tracking] React-docgen related issues #26606

Open yannbf opened 8 months ago

yannbf commented 8 months ago

NOTE: For anybody who is unaware, a workaround for many (most?) of these issues is to set typescript.reactDocgen to react-docgen-typescript in .storybook/main.js. Learn more.

Describe the bug

This will serve as an umbrella issue where we document all the issues regarding react-docgen. It will be updated over time.

React-docgen related issues

### Performance related
- [ ] https://github.com/storybookjs/storybook/issues/26543
### Limitations
- [ ] https://github.com/storybookjs/storybook/issues/26548
- [ ] https://github.com/storybookjs/storybook/issues/26406
- [ ] https://github.com/storybookjs/storybook/issues/26467
- [ ] https://github.com/storybookjs/storybook/issues/26407
- [ ] https://github.com/storybookjs/storybook/issues/25909
- [ ] https://github.com/storybookjs/storybook/issues/26652
- [ ] https://github.com/storybookjs/storybook/discussions/26583
- [ ] https://github.com/storybookjs/storybook/issues/26745
- [ ] https://github.com/storybookjs/storybook/issues/26780
- [ ] https://github.com/storybookjs/storybook/issues/26496#issuecomment-2049774433

Reproduction

In order to assist the React docgen maintainer to fix as many of these issues as possible, here's a reproduction that shows all these scenarios, with options to run Storybook with both react-docgen and react-docgen-typescript for comparison:

https://stackblitz.com/edit/react-docgen-issues-and-limitations

federico-ntr commented 7 months ago

Just wanted to report an issue I opened some weeks ago regarding react-docgen.
I have opened an issue on react-docgen repo as well.