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

Add Box--overlay styles + remove styleguide.css from docs #1754

Merged
merged 5 commits into from
Nov 16, 2021

Conversation

simurai
Copy link
Contributor

@simurai simurai commented Nov 16, 2021

We have been loading the https://github.com/site/assets/styleguide.css bundle into the docs only because the Box--overlay component is already documented but the styles live still in dotcom. So this PR...

  • Adds the Box--overlay styles from dotcom
    • Note that the Overlay styles are not included because I think they are not used anywhere.
  • Removes loading the styleguide.css bundle in the docs

I think long term we should deprecate Box--overlay because it looks like it's a variation of the Box component. But it probably should be an independent component like PRC's Dialog.


⚠️ When shipping this to dotcom the source order of Box--overlay is different:

Before After
behaviors.css (as part of dotcom "components") frameworks.css (as part of PCSS "core")

So we'll have to be on the lookout for regressions.


Part of https://github.com/github/primer/issues/393

@changeset-bot
Copy link

changeset-bot bot commented Nov 16, 2021

🦋 Changeset detected

Latest commit: e032a98

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@primer/css Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@simurai simurai marked this pull request as ready for review November 16, 2021 08:37
@simurai simurai requested a review from a team as a code owner November 16, 2021 08:37
@simurai simurai requested a review from jonrohan November 16, 2021 08:37
Copy link
Contributor

@langermank langermank left a comment

Choose a reason for hiding this comment

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

Woohoo!

@jonrohan jonrohan enabled auto-merge (squash) November 16, 2021 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants