reactjs / reactjs/react-docgen

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

Aperta
#566 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
TypeScript
Stelle
3.8k
Fork
316
Merge medio
5h 7m
PR unite (30g)
4

Descrizione

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?

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Non vengono indicati file, test o punti di ingresso; inizia individuando il parser docgen o l’API che estrae i metadati dei componenti React e la relativa copertura di test esistente. Il lavoro è completato quando, oltre alle informazioni documentate sulle prop, viene esposto anche il tag HTML nativo renderizzato, con una copertura che dimostri il caso h1.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
react, typescript
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.