Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Feature: Option to remove `| undefined` from optional prop types

Fermée
  • Quelque chose ne va pas ?
#1,134 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
58/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Active
Stack technique
typescript
Domaine
documentation, tooling

Piste de recherche

Commencez par localiser le point d’entrée du parser TypeScript et la gestion de ses options de parser ; aucun fichier ni test n’est nommé dans l’issue. Comparez l’option demandée avec le travail antérieur lié de react-docgen-typescript, puis vérifiez que l’analyse activée supprime | undefined des types de props optionnelles tout en conservant le type pertinent au lieu de signaler une union.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Problem

When using TypeScript's explicit optional property pattern (prop?: Type | undefined), react-docgen displays the type as union instead of showing the actual type.

This pattern is common in codebases using exactOptionalPropertyTypes: true in tsconfig, which requires explicit | undefined for optional properties.

Example
interface ButtonProps {
  onClick?: ((event: MouseEvent) => void) | undefined
  variant?: 'primary' | 'secondary' | undefined
  icon?: ReactNode | undefined
}

In Storybook's props table (using react-docgen), these all display as "union" instead of:

  • (event: MouseEvent) => void
  • 'primary' | 'secondary'
  • ReactNode

Requested Feature

Add a parser option similar to react-docgen-typescript's shouldRemoveUndefinedFromOptional:

{
  shouldRemoveUndefinedFromOptional: true
}

When enabled, this would:

  1. Detect optional properties (those ending with ?)
  2. Strip | undefined from their type representation
  3. Display the actual meaningful type instead of "union"

Prior Art

react-docgen-typescript has this feature via the shouldRemoveUndefinedFromOptional option:
https://github.com/styleguidist/react-docgen-typescript#parseroptions

Workaround

Currently, Storybook users must manually specify table.type.summary for every affected prop:

argTypes: {
  onClick: {
    table: { type: { summary: '(event: MouseEvent) => void' } }
  }
}

This is tedious and error-prone for large component libraries.

Environment

  • react-docgen: latest
  • TypeScript: 7.x with exactOptionalPropertyTypes: true
  • Storybook: 10.x using reactDocgen: 'react-docgen'
Langage dominant
TypeScript
Étoiles
3.8k
Forks
316
Merge moyen
9 min
PR mergées (30 j)
2

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de reactjs/react-docgen

Toutes les issues de reactjs/react-docgen

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.