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

feat: Export common SCSS variables as CSS variables #1620

Closed
wants to merge 2 commits into from

Conversation

xitij2000
Copy link
Contributor

Description

This commit exports commonly-used SCSS variables as CSS variables as well so
that they can be used by MFEs, or other consumers of Paragon, without needing to
be rebuilt each time a theme variable changes.

Deploy Preview

Include a direct link to your changes in this PR's deploy preview here (e.g., a specific component page).

Merge Checklist

  • If your update includes visual changes, have they been reviewed by a designer? Send them a link to the Netlify deploy preview, if applicable.
  • Does your change adhere to the documented style conventions?
  • Do any prop types have missing descriptions in the Props API tables in the documentation site (check deploy preview)?
  • Were your changes tested using all available themes (see theme switcher in the header of the deploy preview, under the "Settings" icon)?
  • Were your changes tested in the example app?
  • Is there adequate test coverage for your changes?
  • Consider whether this change needs to reviewed/QA'ed for accessibility (a11y). If so, please add wittjeff and adamstankiewicz as reviewers on this PR.

Post-merge Checklist

  • Verify your changes were released to NPM at the expected version.
  • If you'd like, share your contribution in #show-and-tell.
  • 🎉 🙌 Celebrate! Thanks for your contribution.

@openedx-webhooks
Copy link

Thanks for the pull request, @xitij2000! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 12, 2022
@netlify
Copy link

netlify bot commented Sep 12, 2022

Deploy Preview for paragon-openedx ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 136c94e
🔍 Latest deploy log https://app.netlify.com/sites/paragon-openedx/deploys/63354ebb816ba200086dbacd
😎 Deploy Preview https://deploy-preview-1620--paragon-openedx.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

}

@each $size, $length in $spacers {
--png-spacer-#{$size}: #{$length};

Choose a reason for hiding this comment

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

Suggested change
--png-spacer-#{$size}: #{$length};
--pgn-spacer-#{$size}: #{$length};

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is no longer needed with the most recent changes.

@xitij2000 xitij2000 force-pushed the kshitij/export-css-vars branch 2 times, most recently from d5837cc to 25ce666 Compare September 14, 2022 08:29
@tecoholic
Copy link

@xitij2000 👍 with the linting issue fixed

  • I tested this: I built this, added the output css into an independent html file, and used the CSS values using var()
  • I read through the code
  • I checked for accessibility issues - NA
  • Includes documentation

@xitij2000 xitij2000 force-pushed the kshitij/export-css-vars branch from 25ce666 to 1bdb6cb Compare September 19, 2022 13:04
@codecov
Copy link

codecov bot commented Sep 19, 2022

Codecov Report

Base: 90.40% // Head: 90.40% // No change to project coverage 👍

Coverage data is based on head (136c94e) compared to base (2e7847f).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1620   +/-   ##
=======================================
  Coverage   90.40%   90.40%           
=======================================
  Files         208      208           
  Lines        3534     3534           
  Branches      824      824           
=======================================
  Hits         3195     3195           
  Misses        324      324           
  Partials       15       15           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@xitij2000 xitij2000 force-pushed the kshitij/export-css-vars branch from 1bdb6cb to 2823b2c Compare September 19, 2022 14:47
@natabene
Copy link

@xitij2000 Thank you for the contribution. Is this ready for our review?

@xitij2000
Copy link
Contributor Author

@xitij2000 Thank you for the contribution. Is this ready for our review?

Yes. Thanks!

This commit exports commonly-used SCSS variables as CSS variables as well so
that they can be used by MFEs, or other consumers of Paragon, without needing to
be rebuilt each time a theme variable changes.
@xitij2000 xitij2000 force-pushed the kshitij/export-css-vars branch from 2823b2c to 136c94e Compare September 29, 2022 07:52
@mphilbrick211
Copy link

Hi @xitij2000 - is this PR still needed? If so, I can get it reviewed. Looks like it fell off the radar.

@mphilbrick211 mphilbrick211 added the inactive PR author has been unresponsive for several months label Dec 28, 2022
@xitij2000
Copy link
Contributor Author

Hi @xitij2000 - is this PR still needed? If so, I can get it reviewed. Looks like it fell off the radar.

I think this work is overshadowed by the design tokens work going on. I will close this PR for now, and reopen if needed.

@xitij2000 xitij2000 closed this Dec 29, 2022
@openedx-webhooks
Copy link

@xitij2000 Even though your pull request wasn’t merged, please take a moment to answer a two question survey so we can improve your experience in the future.

@mphilbrick211 mphilbrick211 removed the inactive PR author has been unresponsive for several months label Jan 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

6 participants