storybookjs/storybook

[Bug]: Autodocs "union" type

Open

Aperta il 22 dic 2023

Vedi su GitHub
 (9 commenti) (1 reazione) (0 assegnatari)TypeScript (89.909 star) (10.058 fork)batch import
argtypesbughelp wantedreacttypescript

Descrizione

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

Guida contributor

Tech stack
vuetypescript
Dominio
documentation
Tipo issue
bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
half day
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
active
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Basic knowledge of TypeScript typesFamiliarity with Storybook autodocsVue component basics
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65
Direzione di ricerca
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.