storybookjs/storybook

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

Geschlossen

#24.174 geöffnet am 14.09.2023

 (8 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (10.058 Forks)batch import
argtypeshelp wantedtypescript

Repository-Metriken

Stars
 (89.909 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 7T 22h) (184 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide