[EuiComboBox] Improved props table for EuiComboBox#4563
[EuiComboBox] Improved props table for EuiComboBox#4563chandlerprall merged 6 commits intoelastic:masterfrom
Conversation
|
Since this is a community submitted pull request, a Jenkins build has not been kicked off automatically. Can an Elastic organization member please verify the contents of this patch and then kick off a build manually? |
|
jenkins test this |
|
Preview documentation changes for this PR: https://eui.elastic.co/pr_4563/ |
|
Looking into why this renders so weirdly. |
|
@chandlerprall what needs to be done for this? |
|
Sorry for the delay, still need to look into why this renders like this - my initial search didn't show anything obvious. Instead of rendering "EuiComboBoxOptionOption" under the "Prop" column, it is supposed to list each prop from the EuiComboBoxOptionOption type in separate rows. |
|
It seems only types declared using interface declaration renders list of each prop defined within it in separate rows and those defined using type alias declaration (in our case) lists the alias itself under the prop column. |
|
changing the type alias declaration of EuiComboBoxOptionOption to interface declaration fixes this
|
|
Nice find! This looks good, will deploy through CI for final verification. jenkins test this |
|
Preview documentation changes for this PR: https://eui.elastic.co/pr_4563/ |
|
Oh, one last thing. It's useful to link between the Let's add a similar comment to EuiComboBox directing the user to the new section. |
|
@chandlerprall i have made the changes :-) |
|
jenkins test this |
|
Preview documentation changes for this PR: https://eui.elastic.co/pr_4563/ |
chandlerprall
left a comment
There was a problem hiding this comment.
Changes look good, tested props table rendering & link between EuiComboBox::options -> EuiComboBoxOptionOption tables; 👍 thanks again!
Summary
This PR Fixes: #1981
Improved props table for
EuiComboBox.Imported EuiComboBoxOptionOption using the
prop-loadersyntax and added it to the props key of the example.Checklist
- [ ] Props have proper autodocs and playground toggles- [ ] Checked Code Sandbox works for the any docs examples- [ ] Added or updated jest tests- [ ] Checked for breaking changes and labeled appropriately- [ ] Checked for accessibility including keyboard-only and screenreader modes- [ ] A changelog entry exists and is marked appropriately