storybookjs/storybook

[Bug]: Autodocs "union" type

Open

#25,305 创建于 2023年12月22日

在 GitHub 查看
 (9 评论) (1 反应) (0 负责人)TypeScript (89,909 star) (10,058 fork)batch import
argtypesbughelp wantedreacttypescript

描述

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

贡献者指南

技术栈
vuetypescript
领域
documentation
议题类型
bug
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
active
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Basic knowledge of TypeScript typesFamiliarity with Storybook autodocsVue component basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65
研究方向
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.