Skip to main content Red Hat Design System logo Contribute on Github

Breadcrumb

Overview Style Guidelines Code Accessibility

Installation

Red Hat CDN

CDN Prerelease

We are currently working on our CDN, which will be soon moving into beta. This will be the preferred method of installation in the near future. If you are a Red Hat associate and have questions or comments about the CDN or installation process please join us in our Red Hat Design System Google chat.

In the meantime, install this component using npm

The recommended way to load RHDS is via the Red Hat Digital Experience CDN, and using an import map.

If you have full control over the page you are using, add an import map to the <head>, pointing to the CDN, or update any existing import map. If you are not responsible for the page's <head>, request that the page owner makes the change on your behalf.

<script type="importmap">
  {
    "imports": {
      "@rhds/elements/": "https://www.redhatstatic.com/dx/v1-alpha/@rhds/elements@1.1.0/elements/",
      "@patternfly/elements/": "https://www.redhatstatic.com/dx/v1-alpha/@patternfly/elements@2.2.2/"
    }
  }
</script>

Once the import map is established, you can load the element with the following module, containing a bare module specifier:

<script type="module">
  import '@rhds/elements/rh-breadcrumb/rh-breadcrumb.js';
</script>

Note that Modules may be placed in the <head>: since they are deferred by default, they will not block rendering.

 NPM

Install RHDS using your team's preferred NPM package manager, e.g.

npm install @rhds/elements

Once that's been accomplished, you will need to use a bundler to resolve the bare module specifiers and optionally optimize the package for your site's particular use case and needs. Comprehensive guides to bundling are beyond the scope of this page; read more about bundlers on their websites:

 JSPM

Public CDNs

JSPM and other public CDNs should not be used on corporate domains. Use them for development purposes only!

Add an import map to the <head>, pointing to the CDN, or update any existing import map.

<script type="importmap">
  {
    "imports": {
      "@rhds/elements/": "https://jspm.dev/@rhds/elements/",
      "@patternfly/elements/": "https://jspm.dev/@patternfly/elements/"
    }
  }
</script>

Once the import map is established, you can load the element with the following module, containing a bare module specifier:

<script type="module">
  import '@rhds/elements/rh-breadcrumb/rh-breadcrumb.js';
</script>

Note that Modules may be placed in the <head>: since they are deferred by default, they will not block rendering.

Usage 

<rh-breadcrumb>
  <ol>
    <li><a href="#">Home</a></li>
    <li><a href="#">Products</a></li>
    <li><a href="#">Red Hat OpenShift on AWS</a></li>
    <li><a href="#">4</a></li>
    <li><a href="#">Introduction to ROSA</a></li>
    <li><a href="#" aria-current="page">Chapter 1. Understanding ROSA</a></li>
  </ol>
</rh-breadcrumb>

rh-breadcrumb

Slots 1
Slot Name Description

Place an ordered list (<ol>) of your breadcrumbs into the slot
Attributes 2
DOM Property Description Type Default
accessibleLabel

Customize the default aria-label on the <nav> container. Defaults to "Breadcrumb" if no attribute/property is set.

 
string | undefined
 
unknown
variant

Sets variants to breadcrumbs

 
'subtle' | undefined
 
unknown
Methods 0

None

 Events 0

None

 CSS Shadow Parts 1
Part Name Description
container

container element for slotted breadcrumb
CSS Custom Properties 10
CSS Property Description Default
--rh-breadcrumb-link-color

The link color for each anchor in the list

 var(--rh-color-interactive-blue-darker, #0066cc)
--rh-breadcrumb-link-color-current-page

The current page's color

 var(--rh-color-text-primary-on-light, #151515)
--rh-breadcrumb-link-color-current-page-subtle

The current page's color for the subtle variant

 var(--rh-color-text-secondary-on-light, #4d4d4d)
--rh-breadcrumb-link-color-hover

The link color on hover/focus/active for each anchor in the list

 var(--rh-color-interactive-blue-darkest, #003366)
--rh-breadcrumb-link-color-visited

The visited color for each breadcrumb link

 var(--rh-color-interactive-purple-darker, #5e40be)
--rh-breadcrumb-link-color-visited-hover

The visited color on hover for each breadcrumb link

 var(--rh-color-interactive-purple-darkest, #21134d)
--rh-breadcrumb-link-focus-outline-color

The link focus outline color

 var(--rh-color-border-interactive-on-light, #0066cc)
--rh-breadcrumb-li-padding-inline-end

Sets the spacing between each breadcrumb item.

 var(--rh-breadcrumb-li-padding-inline-end, 42px)
--rh-breadcrumb-caret-image

The default background image separating each breadcrumb item

 var(--rh-breadcrumb-caret-image, url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='10' height='15' viewBox='0 0 10 15' fill='none'%3E%3Cg clip-path='url(%23clip0_232_19576)'%3E%3Cpath d='M2.5 14.5L0.5 12.5L5.5 7.5L0.5 2.5L2.5 0.5L9.5 7.5L2.5 14.5Z' fill='%23ffffff'/%3E%3C/g%3E%3Cdefs%3E%3CclipPath id='clip0_232_19576'%3E%3Crect width='10' height='14' fill='white' transform='matrix(-1 0 0 1 10 0.5)'/%3E%3C/clipPath%3E%3C/defs%3E%3C/svg%3E"))
--rh-breadcrumb-caret-image-subtle

The subtle variant background image separating each breadcrumb item

 var(--rh-breadcrumb-caret-image-subtle, url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='10' height='15' viewBox='0 0 10 15' fill='none'%3E%3Cg clip-path='url(%23clip0_232_19576)'%3E%3Cpath d='M2.5 14.5L0.5 12.5L5.5 7.5L0.5 2.5L2.5 0.5L9.5 7.5L2.5 14.5Z' fill='%23a3a3a3'/%3E%3C/g%3E%3Cdefs%3E%3CclipPath id='clip0_232_19576'%3E%3Crect width='10' height='14' fill='white' transform='matrix(-1 0 0 1 10 0.5)'/%3E%3C/clipPath%3E%3C/defs%3E%3C/svg%3E"))
Design Tokens 0

None
© 2021-2024 Red Hat, Inc. Deploys by Netlify