Skip to content

Breadcrumbs

Use breadcrumbs to show navigational context on pages that are many levels deep in a site’s hierarchy. Breadcrumbs show and link to parent, grandparent, and sometimes great-grandparent pages.
  • Alpha
  • Review pending by accessibility team
import {Breadcrumbs} from '@primer/react'

Breadcrumbs are used to show taxonomical context on pages that are many levels deep in a site’s hierarchy. Breadcrumbs show and link to parent, grandparent, and sometimes great-grandparent pages. Breadcrumbs are most appropriate on pages that:

  • Are many levels deep on a site
  • Do not have a section-level navigation
  • May need the ability to quickly go back to the previous (parent) page

To use Breadcrumbs with react-router or react-router-dom, pass as={NavLink} and omit the selected prop. This ensures that the NavLink gets activeClassName='selected'

Examples

Props

NameTypeDefaultDescription
children
Breadcrumbs.Item[]
sx
SystemStyleObject
Style overrides to apply to the component. See also overriding styles.
NameTypeDefaultDescription
selected
boolean
false
sx
SystemStyleObject
Style overrides to apply to the component. See also overriding styles.
as
React.ElementType
"a"The underlying element to render — either a HTML element name or a React component.
ref
React.RefObject<HTMLAnchorElement>
A ref to the element rendered by this component. Because this component is polymorphic, the type will vary based on the value of the as prop.
Additional props are passed to the <a> element. See MDN for a list of props accepted by the <a> element. If an as prop is specified, the accepted props will change accordingly.

Status

Alpha

  • Component 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.

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 has been manually reviewed by the accessibility team and any resulting issues have been addressed.

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.