storybookjs/storybook

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

Fechada

#24.174 aberto em 14 de set. de 2023

 (8 comentários) (0 reação) (0 responsável)TypeScript (10.058 forks)batch import
argtypeshelp wantedtypescript

Métricas do repositório

Stars
 (89.909 estrelas)
Métricas de merge de PR
 (Mesclagem média 7d 22h) (184 fundiu PRs em 30d)

Description

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.

Guia do colaborador