VDS

Breadcrumb

Navigation path to the current page.

Installation

npm install @vds-testing/react @vds-testing/styles
npm install @vds-testing/elements @vds-testing/styles

See Installation for CSS setup.

Usage

React:

import {
  Breadcrumb,
  BreadcrumbList,
  BreadcrumbItem,
  BreadcrumbLink,
  BreadcrumbPage,
  BreadcrumbSeparator,
} from "@vds-testing/react"
<Breadcrumb>
  <BreadcrumbList>
    <BreadcrumbItem>
      <BreadcrumbLink href="/">Home</BreadcrumbLink>
    </BreadcrumbItem>
    <BreadcrumbSeparator />
    <BreadcrumbItem>
      <BreadcrumbPage>Current</BreadcrumbPage>
    </BreadcrumbItem>
  </BreadcrumbList>
</Breadcrumb>

Web Components:

<script type="module">
  import "@vds-testing/elements";
</script>
<vds-breadcrumb>
  <vds-breadcrumb-list>
    <vds-breadcrumb-item>
      <vds-breadcrumb-link href="/">Home</vds-breadcrumb-link>
    </vds-breadcrumb-item>
    <vds-breadcrumb-separator></vds-breadcrumb-separator>
    <vds-breadcrumb-item>
      <vds-breadcrumb-page>Current</vds-breadcrumb-page>
    </vds-breadcrumb-item>
  </vds-breadcrumb-list>
</vds-breadcrumb>

Examples

With icon

Collapsed

Anatomy

  • Breadcrumb - The root nav element
  • BreadcrumbList - Ordered list container
  • BreadcrumbItem - Individual list item
  • BreadcrumbLink - Clickable navigation link
  • BreadcrumbPage - Current page indicator (not clickable)
  • BreadcrumbSeparator - Visual separator between items
  • BreadcrumbEllipsis - Collapsed items indicator

Props

Prop Type Default Description
href string required Link destination
class string - Additional CSS classes

All other Breadcrumb components accept class for additional CSS classes.