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

[EuiComboBox] Improved props table for EuiComboBox #4563

Merged
merged 6 commits into from
Mar 2, 2021

Conversation

akashgp09
Copy link
Contributor

Summary

This PR Fixes: #1981

Improved props table for EuiComboBox.
Imported EuiComboBoxOptionOption using the prop-loader syntax and added it to the props key of the example.

Screenshot 2021-02-21 201120

Checklist

  • Check against all themes for compatibility in both light and dark modes
  • Checked in mobile
  • Checked in Chrome, Edge, and Firefox
    - [ ] Props have proper autodocs and playground toggles
  • Added documentation
    - [ ] 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

@kibanamachine
Copy link

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?

@chandlerprall
Copy link
Contributor

jenkins test this

@kibanamachine
Copy link

Preview documentation changes for this PR: https://eui.elastic.co/pr_4563/

@chandlerprall
Copy link
Contributor

Looking into why this renders so weirdly.

@akashgp09
Copy link
Contributor Author

@chandlerprall what needs to be done for this?

@chandlerprall
Copy link
Contributor

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.

@akashgp09
Copy link
Contributor Author

akashgp09 commented Feb 26, 2021

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.

@akashgp09
Copy link
Contributor Author

akashgp09 commented Feb 26, 2021

changing the type alias declaration of EuiComboBoxOptionOption to interface declaration fixes this

Screenshot 2021-02-26 215903

@chandlerprall
Copy link
Contributor

Nice find! This looks good, will deploy through CI for final verification.

jenkins test this

@kibanamachine
Copy link

Preview documentation changes for this PR: https://eui.elastic.co/pr_4563/

@chandlerprall
Copy link
Contributor

Oh, one last thing. It's useful to link between the options row in EuiComboBox's props to the new EuiComboBoxOptionOption section. An example of this is EuiDataGrid's props pointing at #EuiDataGridColumnActions in the actions prop: https://github.com/elastic/eui/blob/master/src/components/datagrid/data_grid_types.ts#L81-L84

Let's add a similar comment to EuiComboBox directing the user to the new section.

@akashgp09
Copy link
Contributor Author

@chandlerprall i have made the changes :-)

@chandlerprall
Copy link
Contributor

jenkins test this

@kibanamachine
Copy link

Preview documentation changes for this PR: https://eui.elastic.co/pr_4563/

Copy link
Contributor

@chandlerprall chandlerprall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good, tested props table rendering & link between EuiComboBox::options -> EuiComboBoxOptionOption tables; 👍 thanks again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[EuiComboBox] Document the structure the options object
3 participants