storybookjs/storybook

[Bug]: Autodocs "union" type

Open

#25 305 ouverte le 22 déc. 2023

Voir sur GitHub
 (9 commentaires) (1 réaction) (0 assignés)TypeScript (89 909 stars) (10 058 forks)batch import
argtypesbughelp wantedreacttypescript

Description

Describe the bug

I have defined some props on the component with union. For example:

export interface MyComponentProps { title: string; subtitle?: string | undefined; }

I wrote a story for my component, added "autodocs" to tags and Storybook generated controls but for prop subtitle I got type union. I expected to see string | undefined.

To Reproduce

Add prop type for example string | undefined.

System

storybook: 7.6.5 @storybook/vue3: 7.6.5 @storybook/vue3-vite: 7.6.5

Additional context

No response

Guide contributeur

Stack technique
vuetypescript
Domaine
documentation
Type d'issue
bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Basic knowledge of TypeScript typesFamiliarity with Storybook autodocsVue component basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65
Direction de recherche
Investigate how the Storybook autodocs system renders union types like 'string | undefined'. The issue suggests that it currently outputs 'union' instead of the actual type. Look at the type renderer in the autodocs addon (likely components related to PropRow or ArgTable) to see how it resolves union types. Check if there's a missing case in the type mapping. See comments for any additional clues.