Skip to content

[Docs] Props table default values for complex components #5118

@thompsongl

Description

@thompsongl

I haven't been able to get react-docgen-typescript to find the default values. The forwardRef + TypeScript generic problem and workaround (described here) that we've had to do either leaves us with insufficient type safety for consumers or insufficient documentation.
We could add the default values to the prop comments using the jsdoc tag, which react-docgen-typescript understands.

Originally posted by @thompsongl in #5011 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationIssues or PRs that only affect documentation - will not need changelog entries

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions