-
Notifications
You must be signed in to change notification settings - Fork 221
chore: update styling guide #5437
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
|
Branch previewReview the following VRT differencesWhen a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:
If the changes are expected, update the |
Tachometer resultsCurrently, no packages are changed by this PR... |
9287d3b
to
c4f765c
Compare
544b96f
to
1748f16
Compare
1748f16
to
e99fa99
Compare
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.
Looks great! I'll approve once it's pointed to the CSS-Cutoff branch.
4545811
to
cb5c609
Compare
cb5c609
to
2ffd597
Compare
* chore: add styling guide * chore: remove spectrum-config and update other docs * fix: update yarn new-package to not depend on spectrum-css * chore: update styling guide * chore: remove formating from plopfile
* chore: add styling guide * chore: remove spectrum-config and update other docs * fix: update yarn new-package to not depend on spectrum-css * chore: update styling guide * chore: remove formating from plopfile
* chore: add styling guide * chore: remove spectrum-config and update other docs * fix: update yarn new-package to not depend on spectrum-css * chore: update styling guide * chore: remove formating from plopfile
Update Styling Documentation for SWC Components
Description
This PR documents the new guidance for maintaining styles in Spectrum Web Components (SWC). It clarifies the purpose and usage of the three stylesheets associated with each component:
spectrum-[component].css
: The base stylesheet originally from spectrum-css.[component]-overrides.css
: The overrides stylesheet originally from spectrum-css.[component].css
: The last loaded stylesheet, which serves as the SWC override stylesheet.Additionally, it includes details about the tools/styles and theme files (s1, express, s2foundation) and updates the relevant documentation files.
Motivation and context
This change is required to provide clear and thorough styling guidance for developers working with SWC components. It addresses the confusion around the usage of multiple stylesheets and ensures that anyone can understand how to update themes and style new components effectively.
Related issue(s)
Screenshots (if appropriate)
Author's checklist
Reviewer's checklist
patch
,minor
, ormajor
featuresManual review test cases
Verify that the following docs doesn't reference to spectrum-css package
Read the new styling guide doc and verify if it does a good job explaining how to style our components without the spectrum-css dependency
Verify
yarn new package
works as expectedyarn && yarn build
yarn new package
Note: Newly generated package should have all the files mentioned in generating-components and shouldn't depend on spectrum-css.