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

Implement SplitPageLayout #2239

Merged
merged 12 commits into from
Aug 18, 2022
Merged

Implement SplitPageLayout #2239

merged 12 commits into from
Aug 18, 2022

Conversation

colebemis
Copy link
Contributor

@colebemis colebemis commented Aug 17, 2022

Implements draft SplitPageLayout using PageLayout.

👉 SplitPageLayout docs

Note to reviewers: The bulk of the implementation lives in src/SplitPageLayout/SplitPageLayout.tsx

Closes https://github.com/github/primer/issues/793

Merge checklist

  • Added/updated tests
  • Added/updated documentation
  • Tested in Chrome
  • Tested in Firefox
  • Tested in Safari
  • Tested in Edge

Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.

@changeset-bot
Copy link

changeset-bot bot commented Aug 17, 2022

🦋 Changeset detected

Latest commit: 6375a93

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

This PR includes changesets to release 1 package
Name Type
@primer/react Patch

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

@github-actions
Copy link
Contributor

github-actions bot commented Aug 17, 2022

size-limit report 📦

Path Size
dist/browser.esm.js 74.21 KB (+0.01% 🔺)
dist/browser.umd.js 74.75 KB (0%)

@colebemis colebemis temporarily deployed to github-pages August 17, 2022 22:48 Inactive
@colebemis colebemis temporarily deployed to github-pages August 17, 2022 23:21 Inactive
@colebemis colebemis marked this pull request as ready for review August 17, 2022 23:40
@colebemis colebemis requested review from a team and mperrotti August 17, 2022 23:40
@colebemis colebemis temporarily deployed to github-pages August 17, 2022 23:42 Inactive
@@ -1,7 +1,6 @@
import {Meta, Story} from '@storybook/react'
import React from 'react'
Copy link
Contributor

@mperrotti mperrotti Aug 17, 2022

Choose a reason for hiding this comment

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

General feedback unrelated to this specific PR:
For some components we do examples.stories.tsx and fixtures.stories.tsx. This PR is following the file structure ADR, which advocates for one story file per component.

I'm still not totally clear on when/why to split the stories into two files. @siddharthkp - did you write docs about examples.stories.tsx and fixtures.stories.tsx? Have we silently abandoned that way of writing stories?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, I was also curious about this

docs/content/SplitPageLayout.mdx Show resolved Hide resolved
type={`ResponsiveValue<
'start' | 'end'
>`}
type={`| 'start'
Copy link
Contributor

Choose a reason for hiding this comment

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

Non-blocking: This is much clearer to the docs reader than ResponsiveValue<'start' | 'end'>, but it will be annoying to update when/if we change our breakpoints.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agreed. This is a temporary solution until we can think of a better way to document responsive values. Open to ideas!

@colebemis colebemis temporarily deployed to github-pages August 18, 2022 00:22 Inactive
@colebemis colebemis merged commit 041d6d0 into main Aug 18, 2022
@colebemis colebemis deleted the splitpagelayout-impl branch August 18, 2022 00:25
@primer-css primer-css mentioned this pull request Aug 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants