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

[Docs, EuiInMemoryTable] Recreating props tables #4179

Merged

Conversation

miukimiu
Copy link
Contributor

@miukimiu miukimiu commented Oct 26, 2020

Summary

Closes #4149

The EuiInMemoryTable was using a props_info.js file to generate the props table in our docs. With this PR I'm using the new !!prop-loader! to recreate the EuiInMemoryTable props tables.

I'm also deleting the props_info.js from the EuiBasicTable that was also being used to generate the EuiInMemoryTable props tables.

This PR also closes #3623. Now both EuiBasicTable and EuiInMemoryTable props tables are showing common props like data-test-subj and className.

We're still having some issues with export type ... which shows empty. For this reason, #3381 will be addressed with #4129.

Checklist

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

@miukimiu
Copy link
Contributor Author

@thompsongl, when I comment on src/components/search_bar/filters/field_value_selection_filter.tsx:

Screenshot 2020-10-26 at 14 04 09

The props table notes column shows empty:

Screenshot 2020-10-26 at 16 26 34

@kibanamachine
Copy link

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

Copy link
Contributor

@thompsongl thompsongl left a comment

Choose a reason for hiding this comment

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

The props table notes column shows empty

It appears to be working, both the in docs build preview and locally:

Screen Shot 2020-10-26 at 4 58 58 PM

I suspect that the dev server cache loader is to blame in your case; try deleting .cache-loader

@miukimiu
Copy link
Contributor Author

Thanks, @thompsongl. Deleting the cache worked.

@kibanamachine
Copy link

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

Copy link
Contributor

@thompsongl thompsongl left a comment

Choose a reason for hiding this comment

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

Need to merge master and move the changelog entry, but otherwise LGTM
Noted the follow-up PRs mentioned in the summary

@kibanamachine
Copy link

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

@miukimiu miukimiu merged commit bca5946 into elastic:master Oct 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants