Breadcrumbs

Breadcrumbs display the current page or context within the site, allowing them to navigate different levels of the hierarchy.

Work in progressWe are currently transferring the React documentation for Breadcrumbs from a different site to this page. To view the original documentation with code examples, please visit the Primer React documentation for Breadcrumbs.
  • @primer/react@35.25.1
  • Alpha
  • Not reviewed for accessibility

Import

import {Breadcrumbs} from '@primer/react'

Examples

View in Storybook

Props

NameDefaultDescription
children
Breadcrumbs.Item[]
sx
SystemStyleObject
NameDefaultDescription
selected
falseboolean
ref
React.RefObject<HTMLAnchorElement>
as
"a"React.ElementType
sx
SystemStyleObject