reactjs / reactjs/react.dev

Adding description to types

Offen
#6,564 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
JavaScript
Sterne
11.8k
Forks
7.9k
Ø Merge
1 T. 11 Std.
Gemergte PRs (30 T.)
11

Beschreibung

Can we add types description for React types, that can be supported for docs generators?

For example we use next inheritance:

import React, { ButtonHTMLAttributes, FC } from 'react'

export interface ActionIconProps
  extends Pick<
      ButtonHTMLAttributes<HTMLButtonElement>,
      | 'title'
      | 'tabIndex'
      | 'className'
      | 'style'
      | 'aria-label'
      | 'aria-haspopup'
      | 'aria-expanded'
      | 'onClick'
      | 'onKeyDown'
      | 'onMouseDown'
      | 'onFocus'
      | 'onBlur'
      | 'disabled'
    > {
  /** My custom property */
  myProp: string
}

and in doc system like Storybook it generated without description.

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 damit, das ActionIconProps-Beispiel aus dem Issue im Dokumentationsgenerator oder im Storybook-Setup zu reproduzieren. Verfolge, wie geerbte React-Typen und die Beschreibung /** My custom property */ verarbeitet werden; abgeschlossen ist die Arbeit, wenn die generierte Dokumentation die Beschreibungen für diese geerbten und benutzerdefinierten Eigenschaften beibehält.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
react, storybook, typescript
Bereich
documentation, tooling
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
32/100

Neue Issues direkt in Ihr Postfach

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