storybookjs/storybook

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

Open

#24,174 opened on 2023年9月14日

GitHub で見る
 (8 comments) (0 reactions) (0 assignees)TypeScript (89,909 stars) (10,058 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.