[docs] Increased support for TS types -> props table/docgen#6000
Merged
chandlerprall merged 1 commit intoelastic:mainfrom Jun 27, 2022
Merged
[docs] Increased support for TS types -> props table/docgen#6000chandlerprall merged 1 commit intoelastic:mainfrom
chandlerprall merged 1 commit intoelastic:mainfrom
Conversation
|
Preview documentation changes for this PR: https://eui.elastic.co/pr_6000/ |
thompsongl
approved these changes
Jun 27, 2022
Contributor
thompsongl
left a comment
There was a problem hiding this comment.
Awesome! Tested locally with a few different type and interface shapes
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This started by looking at why
EuiPopoverPanelPropswere not showing in the props table in #5977. Turns out the code for TS->docgen was limited to a very specific type def. This PR adds support for basictypes and a fallback to use whatever TS gives us in other cases.It doesn't solve
EuiPopoverPanelPropsin a great way,but at least it shows up now and aligns with how other complex types are displayed. The basic
typehandling does include meaningful details,Checklist
- [ ] Checked in both light and dark modes- [ ] Checked in mobile- [ ] Checked in Chrome, Safari, Edge, and Firefox- [ ] Added documentation- [ ] Checked Code Sandbox works for any docs examples- [ ] Added or updated jest and cypress tests- [ ] Checked for breaking changes and labeled appropriately- [ ] Checked for accessibility including keyboard-only and screenreader modes- [ ] Updated the Figma library counterpart- [ ] A changelog entry exists and is marked appropriately