reactjs / reactjs/react-docgen

Typescript support for defining component Interface through React interface

Offen
#387 8 Kommentare 157 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

bug typescript
Vorherrschende Sprache
TypeScript
Sterne
3.8k
Forks
316
Ø Merge
5 Std. 7 Min.
Gemergte PRs (30 T.)
4

Beschreibung

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.

Screenshot 2019-08-16 at 13 22 06
Screenshot 2019-08-16 at 13 22 36

I'm curious to know if there's a specific reason for this, and if support for this might be on the roadmap.

Thanks!

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit dem Playground-Beispiel unter Verwendung von const MyComponent: React.FC<IProps> = ... und vergleiche es mit der derzeit erkannten Komponentenform. Verfolge, wie react-docgen mit der TypeScript-Schnittstellenreferenz umgeht, und überprüfe anschließend, dass die Schnittstelle IProps erfasst und in der generierten Dokumentation offengelegt wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
react, typescript
Bereich
documentation, tooling
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.