Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
thompsongl opened this issue Oct 12, 2020 · 4 comments
Closed

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

thompsongl opened this issue Oct 12, 2020 · 4 comments
Labels
documentation Issues or PRs that only affect documentation - will not need changelog entries EUI Plus stale-issue stale-issue-closed

Comments

@thompsongl
Copy link
Contributor

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.

@github-actions
Copy link

👋 Hey there. This issue hasn't had any activity for 180 days. We'll automatically close it if that trend continues for another week. If you feel this issue is still valid and needs attention please let us know with a comment.

@daveyholler
Copy link
Contributor

@daveyholler - Look into how Storybook handles types in a props table

@github-actions
Copy link

👋 Hi there - this issue hasn't had any activity in 6 months. If the EUI team has not explicitly expressed that this is something on our roadmap, it's unlikely that we'll pick this issue up. We would sincerely appreciate a PR/community contribution if this is something that matters to you! If not, and there is no further activity on this issue for another 6 months (i.e. it's stale for over a year), the issue will be auto-closed.

Copy link

❌ Per our previous message, this issue is auto-closing after having been open and inactive for a year. If you strongly feel this is still a high-priority issue, or are interested in contributing, please leave a comment or open a new issue linking to this one for context.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues or PRs that only affect documentation - will not need changelog entries EUI Plus stale-issue stale-issue-closed
Projects
None yet
Development

No branches or pull requests

3 participants