React Breadcrumb Component

How to use React Breadcrumb Component.#

The react breadcrumb navigation provides links back to each previous page the user navigated through and shows the current location in a website or an application. You don’t have to add separators, because they automatically added in CSS through ::before and content.

<CBreadcrumb>
  <CBreadcrumbItem active>Home</CBreadcrumbItem>
</CBreadcrumb>

<CBreadcrumb>
  <CBreadcrumbItem href="#">Home</CBreadcrumbItem>
  <CBreadcrumbItem active>Library</CBreadcrumbItem>
</CBreadcrumb>

<CBreadcrumb>
  <CBreadcrumbItem href="#">Home</CBreadcrumbItem>
  <CBreadcrumbItem href="#">Library</CBreadcrumbItem>
  <CBreadcrumbItem active>Data</CBreadcrumbItem>
</CBreadcrumb>

Dividers#

Dividers are automatically added in CSS through ::before and content. They can be changed by modifying a local CSS custom property --coreui-breadcrumb-divider, or through the $breadcrumb-divider Sass variable — and $breadcrumb-divider-flipped for its RTL counterpart, if needed. We default to our Sass variable, which is set as a fallback to the custom property. This way, you get a global divider that you can override without recompiling CSS at any time.

<CBreadcrumb style={{"--cui-breadcrumb-divider": "'>'"}}>
  <CBreadcrumbItem href="#">Home</CBreadcrumbItem>
  <CBreadcrumbItem active>Library</CBreadcrumbItem>
</CBreadcrumb>

When modifying via Sass, the quote function is required to generate the quotes around a string. For example, using > as the divider, you can use this:

$breadcrumb-divider: quote(">");

It's also possible to use an embedded SVG icon. Apply it via our CSS custom property, or use the Sass variable.

<CBreadcrumb style={{"--cui-breadcrumb-divider": "url(&#34;data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='8' height='8'%3E%3Cpath d='M2.5 0L1 1.5 3.5 4 1 6.5 2.5 8l4-4-4-4z' fill='currentColor'/%3E%3C/svg%3E&#34;);"}}>
  <CBreadcrumbItem href="#">Home</CBreadcrumbItem>
  <CBreadcrumbItem active>Library</CBreadcrumbItem>
</CBreadcrumb>

$breadcrumb-divider: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' 
width='8' height='8'%3E%3Cpath d='M2.5 0L1 1.5 3.5 4 1 6.5 2.5 8l4-4-4-4z' fill='currentColor'/%3E%3C/svg%3E");

You can also remove the divider setting --cui-breadcrumb-divider: ''; (empty strings in CSS custom properties counts as a value), or setting the Sass variable to $breadcrumb-divider: none;.

<CBreadcrumb style={{"--cui-breadcrumb-divider": "'';"}}>
  <CBreadcrumbItem href="#">Home</CBreadcrumbItem>
  <CBreadcrumbItem active>Library</CBreadcrumbItem>
</CBreadcrumb>

$breadcrumb-divider: none;

Accessibility#

Since react breadcrumbs provide navigation, it's useful to add a significant label such as aria-label="breadcrumb" to explain the type of navigation implemented in the <nav> element. You should also add an aria-current="page" to the last item of the set to show that it represents the current page. CoreUI for React.js automatically add all of this labels to breadcrumb's components.

For more information, see the WAI-ARIA Authoring Practices for the breadcrumb pattern.

Customizing#

CSS variables#

React breadcrumbs use local CSS variables on .breadcrumb for enhanced real-time customization. Values for the CSS variables are set via Sass, so Sass customization is still supported, too.

--cui-breadcrumb-padding-x: #{$breadcrumb-padding-x};
--cui-breadcrumb-padding-y: #{$breadcrumb-padding-y};
--cui-breadcrumb-margin-bottom: #{$breadcrumb-margin-bottom};
@include rfs($breadcrumb-font-size, --cui-breadcrumb-font-size);
--cui-breadcrumb-bg: #{$breadcrumb-bg};
--cui-breadcrumb-border-radius: #{$breadcrumb-border-radius};
--cui-breadcrumb-divider-color: #{$breadcrumb-divider-color};
--cui-breadcrumb-item-padding-x: #{$breadcrumb-item-padding-x};
--cui-breadcrumb-item-active-color: #{$breadcrumb-active-color};

How to use CSS variables#

const vars = { 
  '--my-css-var': 10,
  '--my-another-css-var': "red" 
}
return <CBreadcrumb style={vars}>...</CBreadcrumb>

SASS variables#

$breadcrumb-font-size:              null !default;
$breadcrumb-padding-y:              0 !default;
$breadcrumb-padding-x:              0 !default;
$breadcrumb-item-padding-x:         .5rem !default;
$breadcrumb-margin-bottom:          1rem !default;
$breadcrumb-bg:                     null !default;
$breadcrumb-divider-color:          var(--cui-secondary-color) !default;
$breadcrumb-active-color:           var(--cui-secondary-color) !default;
$breadcrumb-divider:                quote("/") !default;
$breadcrumb-divider-flipped:        $breadcrumb-divider !default;
$breadcrumb-border-radius:          null !default;

API#

CBreadcrumb#

import { CBreadcrumb } from '@coreui/react'
// or
import CBreadcrumb from '@coreui/react/src/components/breadcrumb/CBreadcrumb'

CBreadcrumbItem#

import { CBreadcrumbItem } from '@coreui/react'
// or
import CBreadcrumbItem from '@coreui/react/src/components/breadcrumb/CBreadcrumbItem'