primer / css

Primer is GitHub's design system. This is the CSS implementation
https://primer.style/css
MIT License
12.57k stars 1.21k forks source link

Non-existent pagehead component #539

Closed EdricChan03 closed 6 years ago

EdricChan03 commented 6 years ago

Describe the bug

In the style guide, there's a pagehead component which gives a page a clear, separated title and optional top nav.

However, there's no such thing in the Primer CSS. (Although it seems to work in the style guide itself)

To Reproduce

  1. Go to the Style Guide docs for Pagehead
  2. Copypasta the code into an app with the Primer CSS included
  3. Build the app with Jekyll locally
  4. Notice that there's no CSS for the component

Expected behavior

The pagehead component should exist.

Screenshots

Basic pagehead example
:arrow_up: Basic pagehead example
Actual behaviour in app
:arrow_up: Actual behaviour in app

Desktop (please complete the following information):

Smartphone (please complete the following information):

Additional context EDIT: I was looking for a way to show a header in my Probot app's documentation using Primer. I stumbled upon the Pagehead component and decided to use it.

dmalan commented 6 years ago

Hi all, just wanted to chime in as well to ask if https://styleguide.github.com/primer/components/pagehead/ is on the roadmap? (I noticed, too, that it's flagged as Stable in the Style Guide.) I poked around the existing branches but didn't see any mention of pagehead on, e.g., https://github.com/primer/primer/tree/release-11.0.0. Thank you!

shawnbot commented 6 years ago

Hi @dmalan, the component is indeed not yet part of Primer. We could do a better job of making it clear which components live in the GitHub app source, but for now you can tell by the absence of a package and version indicator on the style guide reference: anything with a package name and version listed is part of Primer; any component without lives elsewhere, and should be considered a “private” API. :v:

dmalan commented 6 years ago

Thanks, @shawnbot, helpful heuristic!

vit1251 commented 6 years ago

@shawnbot you comment was confusing. Could you please remove "pagehead" section from Docs to escape reproduce similar issue.

Right now I already step into that issue and misunderstand what continue in this style section. I hope that you make in sync CSS and docs.

shawnbot commented 6 years ago

@vit1251 I'm sorry if it's been confusing. The Style Guide is primarily for GitHub employees, but we are planning on moving all of the actual Primer docs into this repo and moving the docs for CSS that lives in github.com back into that repo to avoid confusion.

pcj commented 5 years ago

Just spent about an hour trying to figure this one out. Very confusing!

skix123 commented 4 years ago

Any plans for adding this component?

elmehalawi commented 4 years ago

I would love if this component were added too