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

[Docs] Props table default values for complex components #5118

Closed
thompsongl opened this issue Aug 31, 2021 · 1 comment · Fixed by #6541
Closed

[Docs] Props table default values for complex components #5118

thompsongl opened this issue Aug 31, 2021 · 1 comment · Fixed by #6541
Labels
documentation Issues or PRs that only affect documentation - will not need changelog entries

Comments

@thompsongl
Copy link
Contributor

I haven't been able to get react-docgen-typescript to find the default values. The forwardRef + TypeScript generic problem and workaround (described here) that we've had to do either leaves us with insufficient type safety for consumers or insufficient documentation.
We could add the default values to the prop comments using the jsdoc tag, which react-docgen-typescript understands.

Originally posted by @thompsongl in #5011 (comment)

@github-actions
Copy link

👋 Hey there. This issue hasn't had any activity for 180 days. We'll automatically close it if that trend continues for another week. If you feel this issue is still valid and needs attention please let us know with a comment.

@cchaos cchaos added documentation Issues or PRs that only affect documentation - will not need changelog entries skip-stale-check and removed stale-issue labels Feb 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues or PRs that only affect documentation - will not need changelog entries
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants