Skip to content

[prop-loader] Better handling of generic types #4129

@thompsongl

Description

@thompsongl

Work done in #4125 to eliminate manual props info tables for complex components highlights room for improvement in documenting generic types:

image

EuiBasicTable makes use of cascading generics to typeitems, but this is not immediately clear in the docs, nor is it clear what shape T can take.

Updates should include some clearer indication that a type is generic, and some documentation about the default value, extension, or shape of the generic. It could be that we are limited by react-docgen-typescript.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationIssues or PRs that only affect documentation - will not need changelog entriesstale-issue(Don't delete - used for automation)stale-issue-closed(Don't delete - used for automation)

    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