Breadcrumbs

import {BreadcrumbsModule} from "@qualcomm-ui/angular/breadcrumbs"

Overview

  • The root element should be labeled with aria-label="Breadcrumbs" to indicate that it's a breadcrumb navigation.
  • The first breadcrumb item is always the root item, and is typically reserved for the home page or base route of your application.
  • The last breadcrumb item is always the active item.
  • The last breadcrumb item should always be annotated with the aria-current="page" attribute.

Examples

Emphasis (color)

Use the emphasis prop to change the color of the breadcrumbs.

<nav aria-label="Breadcrumbs" emphasis="primary" q-breadcrumbs-root>
  <ol q-breadcrumbs-list>
    <li q-breadcrumb-item>
      <a q-breadcrumb-item-trigger>
        <svg q-breadcrumb-item-icon qIcon="Home"></svg>
        Home
      </a>
    </li>
    <li q-breadcrumb-item>
      <a q-breadcrumb-item-trigger>Components</a>
    </li>
    <li aria-current="page" q-breadcrumb-item>
      <a q-breadcrumb-item-trigger>Breadcrumbs</a>
    </li>
  </ol>
</nav>

Sizes

Three sizes are available via the size prop: sm, md, and lg. The default size is md.

<nav aria-label="Breadcrumbs" q-breadcrumbs-root size="lg">
  <ol q-breadcrumbs-list>
    <li q-breadcrumb-item>
      <a q-breadcrumb-item-trigger>
        <svg q-breadcrumb-item-icon qIcon="Home"></svg>
        Home
      </a>
    </li>
    <li q-breadcrumb-item>
      <a q-breadcrumb-item-trigger>Components</a>
    </li>
    <li aria-current="page" q-breadcrumb-item>
      <a q-breadcrumb-item-trigger>Breadcrumbs</a>
    </li>
  </ol>
</nav>

Apply the routerLink directive to a breadcrumb item's trigger to make it a link.

<nav aria-label="Breadcrumbs" q-breadcrumbs-root>
  <ol q-breadcrumbs-list>
    <li q-breadcrumb-item>
      <a q-breadcrumb-item-trigger routerLink="/">
        <svg q-breadcrumb-item-icon qIcon="Home"></svg>
        Home
      </a>
    </li>
    <li disabled q-breadcrumb-item>
      <a routerLink="/components">Components</a>
    </li>
    <li q-breadcrumb-item>
      <a
        aria-current="page"
        q-breadcrumb-item-trigger
        routerLink="/components/breadcrumbs"
      >
        Breadcrumbs
      </a>
    </li>
  </ol>
</nav>

Disabled Item

Use the disabled prop to disable a breadcrumb item.

<nav aria-label="Breadcrumbs" q-breadcrumbs-root>
  <ol q-breadcrumbs-list>
    <li q-breadcrumb-item>
      <a q-breadcrumb-item-trigger routerLink="/">
        <svg q-breadcrumb-item-icon qIcon="Home"></svg>
        Home
      </a>
    </li>
    <li disabled q-breadcrumb-item>Components</li>
    <li q-breadcrumb-item>
      <a
        aria-current="page"
        q-breadcrumb-item-trigger
        routerLink="/components/breadcrumbs"
      >
        Breadcrumbs
      </a>
    </li>
  </ol>
</nav>

API

q-breadcrumbs-root

PropTypeDefault
Governs the color of the breadcrumb item text and icon.
| 'primary'
| 'neutral'
'primary'
Governs the size of the breadcrumb item text and icon.
| 'sm'
| 'md'
| 'lg'
'md'
Type
| 'primary'
| 'neutral'
Description
Governs the color of the breadcrumb item text and icon.
Type
| 'sm'
| 'md'
| 'lg'
Description
Governs the size of the breadcrumb item text and icon.

q-breadcrumbs-list

q-breadcrumb-item

PropTypeDefault
Controls the component's interactivity. If true, the component becomes unresponsive to input and is visually dimmed to indicate its disabled state.
boolean
The separator element to render between items.
| LucideIconData
| string
ChevronRight
Type
boolean
Description
Controls the component's interactivity. If true, the component becomes unresponsive to input and is visually dimmed to indicate its disabled state.
Type
| LucideIconData
| string
Description
The separator element to render between items.

q-breadcrumb-item-icon

q-breadcrumb-item-trigger

q-breadcrumb-item-separator