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.

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

[Tracking] React-docgen related issues #26606

Open
9 of 11 tasks
yannbf opened this issue Mar 21, 2024 · 2 comments
Open
9 of 11 tasks

[Tracking] React-docgen related issues #26606

yannbf opened this issue Mar 21, 2024 · 2 comments

Comments

@yannbf
Copy link
Member

yannbf commented Mar 21, 2024

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

Preview Give feedback
  1. bug performance issue sev:S2
    valentinpalkovic

Limitations

Preview Give feedback
  1. bug needs triage
  2. bug docgen upgrade:8.0
  3. bug needs triage
  4. bug nextjs
    ndelangen
  5. bug docgen needs more info react
  6. bug needs triage
  7. bug docgen react
  8. Stale bug docgen needs more info react

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
Copy link

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.

@PatrickMunsey
Copy link

I'm seeing a lot of these issue being ticked off and completed.

Adding the following tomain.js re enables autdocs to detect and generate controls with the correct name and description however the default value and type with correct input component is still broken.

Should I create a new issue and add to this list?

I haven't been able to find an existing issue for control input types in autodocs only being strings and objects instead of nice radio buttons or boolean toggles etc.

I mentioned this in another comment :
#28350 (reply in thread)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants