reactjs / reactjs/react-docgen
Typescript support for defining component Interface through React interface
Open
Nobody has claimed this yet.
bug
typescript
- Dominant language
- TypeScript
- Stars
- 3.8k
- Forks
- 316
- Avg merge
- 5h 7m
- Merged PRs (30d)
- 4
Description
I'm playing around with the playground and noticed that if you type your component in this way const MyComponent: React.FC<IProps> = .., react-docgen doesn't pick up the interface in IProps.
I'm curious to know if there's a specific reason for this, and if support for this might be on the roadmap.
Thanks!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the playground example using const MyComponent: React.FC<IProps> = ... and compare it with the currently recognized component form. Trace how react-docgen handles the TypeScript interface reference, then verify that the IProps interface is picked up and exposed in the generated documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100