-
Notifications
You must be signed in to change notification settings - Fork 14.3k
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
feat: Adds the MetadataBar component #21090
feat: Adds the MetadataBar component #21090
Conversation
1921a8a
to
e301e92
Compare
Codecov Report
@@ Coverage Diff @@
## master #21090 +/- ##
==========================================
+ Coverage 66.27% 66.30% +0.02%
==========================================
Files 1770 1772 +2
Lines 67524 67611 +87
Branches 7178 7204 +26
==========================================
+ Hits 44754 44827 +73
- Misses 20936 20942 +6
- Partials 1834 1842 +8
Flags with carried forward coverage won't be shown. Click here to find out more.
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some nits. Looks great. Looking to do some manual testing as well
superset-frontend/src/components/MetadataBar/MetadataBar.test.tsx
Outdated
Show resolved
Hide resolved
@geido Thanks for your comments. I did all your suggestions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
SUMMARY
Adds the MetadataBar component
The metadata bar component is used to display additional information about an entity. Some of the common applications in Superset are:
The metadata bar is by default a static component (besides the links in text). The variations in this component are related to content and entity type as all of the details are predefined in the code and should be specific for each metadata object.
Content types are predefined and consistent across the whole app. This means that they will be displayed and behave in a consistent manner, keeping the same ordering, information formatting, and interactions. For example, the Owner content type will always have the same icon and when hovered it will present who created the entity, its current owners, and when the entity was created.
The Overview page in the Storybook contains the component's documentation with the available content types and their properties.
Configures the Storybook to display MDX content
This will allow developers to create documentation pages about each component using the whole power of MDX. This is one of the improvements we're working on to improve our current design system.
Configures the Storybook to read and display JSDocs
With this configuration, JSDocs added to Typescript metadata will be available in the controls panel in the Storybook. This will reduce the burden when writing stories and promote well-documented components.
@kasiazjc @jess-dillard @eric-briscoe
BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
Screen.Recording.2022-08-15.at.9.11.07.AM.mov
TESTING INSTRUCTIONS
All requirements have associated RTL tests. You can interact with the component in the Storybook.
ADDITIONAL INFORMATION