storybookjs/storybook

[Documentation]: Documentation for `argTypes` is not correct

Open

#24,174 创建于 2023年9月14日

在 GitHub 查看
 (8 评论) (0 反应) (0 负责人)TypeScript (89,909 star) (10,058 fork)batch import
argtypeshelp wantedtypescript

描述

Describe the problem

The docs say:

But the actual type is:

interface InputType {
    name?: string;
    description?: string;
    defaultValue?: any;
    type?: SBType | SBScalarType['name'];
    if?: Conditional;
    [key: string]: any;
}

I'm willing to work on this if it's indeed wrong.

Additional context

Edit: Taking another look at this - you can indeed pass options and control and it does work but it is not documented in the type.

贡献者指南

技术栈
typescriptreact
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
needs maintainer response
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
None
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
Review the documentation for `argTypes` in the Storybook docs directory. Compare the documented type with the actual `InputType` interface from the Storybook source code. Update the documentation to reflect the correct type, including optional properties like `options` and `control`. Confirm with maintainers that the change is accurate before submitting a PR.