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

PageHeader API #2272

Closed
wants to merge 3 commits into from
Closed

PageHeader API #2272

wants to merge 3 commits into from

Conversation

pksjce
Copy link
Collaborator

@pksjce pksjce commented Aug 25, 2022

This PR documents PageHeader proposed API. The implementation PR will be #2265 where the goal is to get the same api as documented here working inside storybooks. I will modify implementation based on feedback here. This PR needs to be merged first before implementation PR.

Link to PageHeader API in figma - https://www.figma.com/file/Ee0OrXuOLXMDqUW83EnDHP/PageHeader-(FY23-Q1)?node-id=2%3A80694
This is the proposed anatomy that seems most complete to me
image

Here are the corresponding figma shots for the three API examples. Together I think this gives us a decent look at the API.

Default

image

With Context Actions and Breadcrumbs

image

With a description and local navigation

image

I'm looking for specific feedback on -

  • API does not communicate that PageHeader.ContextNav will only be visible in narrow mode.
  • The ADR on responsive design proposes a Stack component. I feel like my usecase needs this component. It's not developed yet. I'm planning on making it. WDYT?
  • Naming of components and the depth of the component tree (is it too much?)

@changeset-bot
Copy link

changeset-bot bot commented Aug 25, 2022

⚠️ No Changeset found

Latest commit: 4737924

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@pksjce pksjce requested a review from vdepizzol August 25, 2022 10:32
@github-actions
Copy link
Contributor

github-actions bot commented Aug 25, 2022

size-limit report 📦

Path Size
dist/browser.esm.js 76.26 KB (0%)
dist/browser.umd.js 76.87 KB (0%)


### With Context Actions and Breadcrumbs

<PageHeader>
Copy link
Contributor

Choose a reason for hiding this comment

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

This example and the following examples don't have the jsx live codefence args. Is this intentional?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

nope! it was a mistake. Will fix this 👍

@pksjce
Copy link
Collaborator Author

pksjce commented Oct 11, 2022

Closing this as I've already opened a PR for primer repo

@pksjce pksjce closed this Oct 11, 2022
@joshblack joshblack deleted the pk/page-header-api branch January 19, 2023 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants