Header Alpha Use the Header component to create a header that has all of its items aligned vertically with consistent horizontal spacing
ExamplesAll items directly under the Header component should be a Header.Item
component. Inside these components can be anything (text, forms, images...), and the Header.Item
component will make sure these elements vertically align with each other.
Header.Item
elements have a built-in margin that will need to be overridden with the mr={0}
props for the last element in the container. We relied on the prop here instead of :last-child
because the last child isn't always the item visible. On responsive pages, there's a mobile menu that gets presented to the user at smaller breakpoints.
< Header >
< Header.Item >
< Header.Link href = " # " fontSize = { 2 } >
< StyledOcticon icon = { MarkGithubIcon } size = { 32 } sx = { { mr : 2 } } />
< span > GitHub </ span >
</ Header.Link >
</ Header.Item >
< Header.Item full > Menu </ Header.Item >
< Header.Item mr = { 0 } >
< Avatar src = " https://github.com/octocat.png " size = { 20 } square alt = " @octocat " />
</ Header.Item >
</ Header >
With full-size item< Header >
< Header.Item > Item 1 </ Header.Item >
< Header.Item full border = { 1 } borderStyle = " solid " >
Item 2
</ Header.Item >
< Header.Item mr = { 0 } > Item 3 </ Header.Item >
</ Header >
With links< Header >
< Header.Item >
< Header.Link href = " # " > About </ Header.Link >
</ Header.Item >
< Header.Item >
< Header.Link href = " # " > Releases </ Header.Link >
</ Header.Item >
< Header.Item >
< Header.Link href = " # " > Team </ Header.Link >
</ Header.Item >
</ Header >
PropsName Type Default Description href string URL to be used for the Link sx SystemStyleObject Style overrides to apply to the component. See also overriding styles . Additional props are passed to the <a>
element. See MDN for a list of props accepted by the <a>
element.
Status AlphaComponent props are documented on primer.style/react . Component does not have any unnecessary third-party dependencies. Component can adapt to different themes. Component can adapt to different screen sizes. Component has 100% test coverage. BetaComponent is used in a production application. Common usage examples are documented on primer.style/react . Common usage examples are documented in storybook stories. Component has been reviewed by a systems designer and any resulting issues have been addressed. Component has been manually reviewed by the accessibility team and any resulting issues have been addressed. StableComponent API has been stable with no breaking changes for at least one month. Feedback on API usability has been sought from developers using the component and any resulting issues have been addressed. Component has corresponding design guidelines documented in the interface guidelines . Component has corresponding Figma component in the Primer Web library.