Skip to content
Primer/React
Design
Interface guidelinesOcticonsPresentationsCommand lineMobileDesktop
Build
CSSReactReact BrandViewComponents
ContributeAbout
On this page

Heading

Use Heading to structure your content and provide an accessible experience for users of assistive technologies.
  • Alpha
  • Not reviewed for accessibility
On this page

The Heading component will render an html h2 tag without any default styling. Other heading level elements h1-h6 are available through use of the as prop (see System Props for additional explanation). Please reference the w3 recommendations for headings to ensure your headings provide an accessible experience for screen reader users.

Attention: Make sure to include a valid heading element to render a Heading component other than h2 (<Heading as="h1">H1 Element</Heading>).

Example

Props

Heading

NameTypeDefaultDescription
sx
SystemStyleObject
Style overrides to apply to the component. See also overriding styles.
as
React.ElementType
"h2"The underlying element to render — either a HTML element name or a React component.

Status

Alpha

  • Component props and basic example usage of the component 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 robust unit test coverage (100% where achievable).
  • Component has visual regression coverage of its default and interactive states.
  • Component does not introduce any axe violations.
  • Component has been manually reviewed by the accessibility team and any resulting issues have been addressed.

Beta

  • Component 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 does not introduce any performance regressions.

Stable

  • Component 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.
  • Tooling (such as linters, codemods, etc.) exists to prevent further use of alternatives.
Edit this page on GitHub
4 contributorsbroccolinisoupcolebemisjoshblackrezrah
Last edited by broccolinisoup on March 1, 2023