storybookjs/storybook

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

Open

#24,174 opened on Sep 14, 2023

View on GitHub
 (8 comments) (0 reactions) (0 assignees)TypeScript (89,909 stars) (10,058 forks)batch import
argtypeshelp wantedtypescript

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.

Contributor guide

Tech stack
typescriptreact
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
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.