react icon indicating copy to clipboard operation
react copied to clipboard

PageHeader API

Open pksjce opened this issue 2 years ago • 2 comments

This PR documents PageHeader proposed API. The implementation PR will be https://github.com/primer/react/pull/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?)

pksjce avatar Aug 25 '22 10:08 pksjce

⚠️ No Changeset found

Latest commit: 473792480e728d5416922ca8f111839b05e70fdd

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

changeset-bot[bot] avatar Aug 25 '22 10:08 changeset-bot[bot]

size-limit report 📦

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

github-actions[bot] avatar Aug 25 '22 10:08 github-actions[bot]

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

pksjce avatar Oct 11 '22 02:10 pksjce