-
Notifications
You must be signed in to change notification settings - Fork 97
feat(docs): Improve theming docs #195
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
Conversation
dca0c60 to
d9baaee
Compare
austingreendev
left a comment
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.
This is going to be very helpful! I may be crazy, but is it possible to extract this logic/table creation into the page build process.
Would the following be possible?
- Add the file parsing script output as a webpack global (just a structured array)
- Create a React example in the MD file that uses the provided global to spit out one of our
react-tables?
Otherwise I could see us forgetting to keep this section up-to-date with every addition/retraction.
|
If not added to the build, as Austin suggests, then at a minimum it should be added to the TODO comment section in https://github.com/zendeskgarden/react-components/blob/master/packages/.template/README.md (although this is not the ideal spot to catch all new |
…and use props with css helper
8631a43 to
caf7ab5
Compare
component that renders this in docs
caf7ab5 to
4220291
Compare
austingreendev
left a comment
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 pending @jzempel comment
Description
The theming docs are currently a little light on detail when it comes to the naming used to target the components you wish to write theme overrides for.
Detail
This adds a new component called
<CIDTable />that renders a webpack global calledCOMPONENT_IDS.On doc site build it scans all the js files for component_ids and injects it as a webpack global that is then consumed by
<CIDTable />to render them out.This will make it automagically update anytime any new ids and added and/or changed.
Checklist
designer as a reviewer)
component
yarn start)src/index.jsexport