reactjs / reactjs/react-docgen

Can I "get" the intended HTML element to be rendered?

Offen
#566 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

I would like to document both the props and the HTML element that a react component plans on rendering:

const MyComponent = ({ foo, bar, ...restProps }) => <h1 foo={ foo } bar={bar}  {...restProps } />;

MyComponent.propTypes = {
   foo: PropTypes.string,
   bar: PropTypes.number,
}

In the above example I want to be able to document:

  1. The props stated in propTypes
  2. The "native" HTML props that would be valid for an h1 element.

In the docs i wanna say:
"here are the explicitly set props and this component also takes all valid props for HTMLHeadingElement"

Is it possible for us to get the h1 tag from docgen so we can associate that component's documentation with its html tag?

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

Es werden keine Dateien, Tests oder Einstiegspunkte genannt; beginne damit, den docgen-Parser oder die API zu finden, die React-Komponentenmetadaten extrahiert, sowie die vorhandene Testabdeckung dafür. Fertig ist die Aufgabe, wenn neben den dokumentierten Prop-Informationen auch das gerenderte native HTML-Tag bereitgestellt wird und die Abdeckung den Fall h1 nachweist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
react, typescript
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 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.