-
Notifications
You must be signed in to change notification settings - Fork 51
[WIP-05] [Project Solar / Phase 1 / Showcase] Scaffolding of the showcase pages for the carbonization of the HDS components #3241
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
base: project-solar/phase-1/HDS-5242_showcase/add-themes-support
Are you sure you want to change the base?
[WIP-05] [Project Solar / Phase 1 / Showcase] Scaffolding of the showcase pages for the carbonization of the HDS components #3241
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
19234bc to
cd4e9ef
Compare
cd4e9ef to
a0b23a9
Compare
519a6a6 to
3863dfa
Compare
a0b23a9 to
403ac45
Compare
403ac45 to
9376a33
Compare
9376a33 to
8bc9cc9
Compare
8bc9cc9 to
f8e77f1
Compare
f8e77f1 to
68248e2
Compare
Co-authored-by: Copilot <[email protected]>
…ode review suggestion
…in the comparison grid
…or Carbon theming
…folder/route will be used later to detect if we need to do something around theme switcher and CSS to load
…parison of typographic styles
…onTokenPreviewColor` to show actual color values in preview item
a7943c3 to
2a16e1d
Compare
| <HdsBadge @text="Only text" /> | ||
| </:theming> | ||
| <:reference> | ||
| <cds-tag>Lorem ipsum</cds-tag> |
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.
At first glance, the cds-tag name seemed like a generic element/component name to me (like an HTML "tag") but I see that they are calling they call their "badge" a "tag"... :P
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.
The <ShwCarbonizationComparisonGrid> APIs and implementation here seem pretty clear. Also looking at how they are used within the Carbonized Showcase pages seems quite straightforward.
📌 Summary
This PR is the initial scaffolding of the showcase pages that will be used for the dry-run migrations (and subsequent actual migration) of the HDS components (as in theming/re-skinning).
This PR is based on top of #3240.
🛠️ Detailed description
In this PR I have:
<ShwCarbonizationComparisonGrid>component, used to showcase an HDS component with different themes applied (HDS standard + the four Carbon themesg0/g10/g90/g100) next to the equivalent Carbon web components for that specific variant/state.showcase/app/index.htmlfile to include the scripts (and the hiding styles for the not-yet-loaded web components)🔎 How to review
Note
This is not the final implementation, there will be likely things we will want to change/update, once we start to work on the dry-run migrations; these changes will likely be done in follow-up PRs.
Check the different carbonized pages and how they've been implemented (also their organization as single file
.gtscomponents):Review the implementation of the
<ShwCarbonizationComparisonGrid>component, and see if the API is clear to you; look also at how it's used across the "carbonized" showcase pagesReview how the Carbon Web components are instantiated in the code, and how Carbon theming is applied to them
Note: at the moment there's an open conversation about how to use the
cds-iconweb component in an Ember app, that has not been resolved yet, so we're using theHdsIconcomponent instead👉 👉 👉 Previews:
🛠️ How to test
Note
At the moment the HDS component look the same for the different themes, because the underlying design tokens are all the same; once we start the dry-run migrations (in a follow-up PR) they will start to (should) look more and more like the equivalent Carbon web components shown below
Open the different "carbonized" pages and see how the HDS components are rendered, and how the Carbon Web components are rendered
🗒️ TODOs
showcase/app/index.htmlfile, but importing and instantiating them using the npm packages/dependencies.🔗 External links
Main Jira task:
Related Jira tasks
👀 Component checklist
A changelog entry was added via Changesets if needed (see templates here)💬 Please consider using conventional comments when reviewing this PR.
📋 PCI review checklist
Examples of changes to controls include access controls, encryption, logging, etc.
Examples include changes to operating systems, ports, protocols, services, cryptography-related components, PII processing code, etc.