Breadcrumb

OverviewStyleGuidelinesCodeAccessibilityDemos
  1. Installation
  2. Usage
  1. Installation
  2. Usage

Installation

We recommend import maps when building pages with RHDS. Learn more about how to install on our getting started docs.

Red Hat CDN 
<script type="importmap">
{
  "imports": {
    "@rhds/elements/": "https://www.redhatstatic.com/dx/v1-alpha/@rhds/elements@2.1.1/elements/",
  }
}
</script>
Copy to Clipboard Wrap lines NPM 
npm install @rhds/elements
Copy to Clipboard Wrap lines JSPM 
<script type="importmap">
{
  "imports": {
    "@rhds/elements/rh-breadcrumb/rh-breadcrumb.js": "https://ga.jspm.io/npm:@rhds/elements@2.1.1/rh-breadcrumb/rh-breadcrumb.js"
  },
  "scopes": {
    "https://ga.jspm.io/": {
      "@floating-ui/core": "https://ga.jspm.io/npm:@floating-ui/core@1.6.9/dist/floating-ui.core.mjs",
      "@floating-ui/dom": "https://ga.jspm.io/npm:@floating-ui/dom@1.6.13/dist/floating-ui.dom.mjs",
      "@floating-ui/utils": "https://ga.jspm.io/npm:@floating-ui/utils@0.2.9/dist/floating-ui.utils.mjs",
      "@floating-ui/utils/dom": "https://ga.jspm.io/npm:@floating-ui/utils@0.2.9/dist/floating-ui.utils.dom.mjs",
      "@lit/context": "https://ga.jspm.io/npm:@lit/context@1.1.3/development/index.js",
      "@lit/reactive-element": "https://ga.jspm.io/npm:@lit/reactive-element@2.0.4/development/reactive-element.js",
      "@lit/reactive-element/decorators/": "https://ga.jspm.io/npm:@lit/reactive-element@2.0.4/development/decorators/",
      "@patternfly/pfe-core": "https://ga.jspm.io/npm:@patternfly/pfe-core@4.0.4/core.js",
      "@patternfly/pfe-core/": "https://ga.jspm.io/npm:@patternfly/pfe-core@4.0.4/",
      "@patternfly/pfe-core/ssr-shims.js": "https://ga.jspm.io/npm:@patternfly/pfe-core@4.0.4/core.js",
      "@rhds/elements/lib/": "https://ga.jspm.io/npm:@rhds/elements@2.1.1/lib/",
      "@rhds/elements/": "https://ga.jspm.io/npm:@rhds/elements@2.1.1/elements/",
      "@rhds/icons": "https://ga.jspm.io/npm:@rhds/icons@1.1.2/icons.js",
      "@rhds/icons/ui/": "https://ga.jspm.io/npm:@rhds/icons@1.1.2/ui/",
      "@rhds/tokens/css/": "https://ga.jspm.io/npm:@rhds/tokens@2.1.1/css/",
      "@rhds/tokens/media.js": "https://ga.jspm.io/npm:@rhds/tokens@2.1.1/js/media.js",
      "lit": "https://ga.jspm.io/npm:lit@3.2.1/index.js",
      "lit-element/lit-element.js": "https://ga.jspm.io/npm:lit-element@4.1.1/development/lit-element.js",
      "lit-html": "https://ga.jspm.io/npm:lit-html@3.2.1/development/lit-html.js",
      "lit-html/": "https://ga.jspm.io/npm:lit-html@3.2.1/development/",
      "lit/": "https://ga.jspm.io/npm:lit@3.2.1/",
      "prism-esm": "https://ga.jspm.io/npm:prism-esm@1.29.0-fix.6/prism.js",
      "prism-esm/components/": "https://ga.jspm.io/npm:prism-esm@1.29.0-fix.6/components/",
      "tslib": "https://ga.jspm.io/npm:tslib@2.8.1/tslib.es6.mjs"
    }
  }
}
</script>
Copy to Clipboard Wrap lines

Add it to your page with this import statement

<script type="module">
  import '@rhds/elements/rh-breadcrumb/rh-breadcrumb.js';
</script>
Copy to Clipboard Wrap lines

Lightdom CSS

This element requires you to load "Lightdom CSS" stylesheets for styling deeply slotted elements.

Note

Replace /path/to/ with path to the CSS file, whether local or CDN.

 
<link rel="stylesheet" href="/path/to/rh-breadcrumb/rh-breadcrumb-lightdom.css">

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>

<link rel="stylesheet" href="../rh-breadcrumb-lightdom.css">
<script type="module">
  import '@rhds/elements/rh-breadcrumb/rh-breadcrumb.js';
</script>
Copy to Clipboard Wrap lines

rh-breadcrumb

A breadcrumb navigation is a secondary navigation element consisting of a list of links to the parent pages of the current page in hierarchical order. It helps users find their place within a website or web application.

Slots 1
Slot Name Description

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

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

 
string | undefined
 
unknown
variant 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

 —
--rh-breadcrumb-caret-image-subtle

The subtle variant background image separating each breadcrumb item

 —
Design Tokens 11
Token Copy
--rh-border-radius-default
--rh-color-border-interactive
--rh-color-interactive-primary-default
--rh-color-interactive-primary-hover
--rh-color-interactive-primary-visited-default
--rh-color-interactive-primary-visited-hover
--rh-color-text-primary
--rh-color-text-secondary
--rh-font-size-body-text-sm
--rh-line-height-body-text
--rh-space-md
Edit this page on GitHub