Zum Inhalt springen
Dokumentation

Komponenten

Pfadnavigation (Breadcrumb)

Stabil

Den Weg durch die Hierarchie zeigen und einen Schritt zurück anbieten.

Die Pfadnavigation zeigt, wo in der Hierarchie du dich befindest: Start, Station, Bett und schließlich die aktuelle Seite. Jeder Schritt davor ist ein Link, der letzte Eintrag ist die Seite selbst.

Wann verwenden

  • In tiefen Bereichen wie einer Station mit Zimmern und Betten, wenn der Weg zurücksonst nur über die Seitennavigation möglich wäre.
  • Wenn mehrere Ebenen übereinander liegen und der Kontext sonst verloren geht, etwa „Start › Tickets › #4711“.
  • Direkt unter der Kopfzeile einer Detailseite, damit die Einordnung vor dem Inhalt steht.

Wann nicht

  • Auf der obersten Ebene ist der Pfad leer und sagt nichts aus. Lass ihn dort weg.
  • Für den Wechsel zwischen gleichrangigen Ansichten sind Reiter besser; ein Pfad zeigt Hierarchie, keine Auswahl.
  • Für den Verlauf der zuletzt besuchten Seiten ist die Pfadnavigation nicht gedacht. Sie zeigt den Ort, nicht die Historie.

Aufbau

Breadcrumb ist die Navigation, BreadcrumbList die geordnete Liste, BreadcrumbItem ein Eintrag und BreadcrumbSeparator das Trennzeichen zwischen zwei Einträgen. Der letzte Eintrag ist einer der wenigen Fälle, in denen kein Link, sondern nur Text stehen soll: BreadcrumbPage.

Beispiel und Quelltext
station.tsx
import Link from "next/link";

import {
  Breadcrumb,
  BreadcrumbItem,
  BreadcrumbLink,
  BreadcrumbList,
  BreadcrumbPage,
  BreadcrumbSeparator,
} from "@neodin-eu/ui";

function Station() {
  return (
    <Breadcrumb>
      <BreadcrumbList>
        <BreadcrumbItem>
          <BreadcrumbLink asChild>
            <Link href="/docs">Start</Link>
          </BreadcrumbLink>
        </BreadcrumbItem>
        <BreadcrumbSeparator />
        <BreadcrumbItem>
          <BreadcrumbLink asChild>
            <Link href="/docs/komponenten/navigation/reiter">Station 3</Link>
          </BreadcrumbLink>
        </BreadcrumbItem>
        <BreadcrumbSeparator />
        <BreadcrumbItem>
          <BreadcrumbPage>Bettenbelegung</BreadcrumbPage>
        </BreadcrumbItem>
      </BreadcrumbList>
    </Breadcrumb>
  );
}

Lange Pfade kürzen

Bei vielen Ebenen wird der Pfad unruhig. BreadcrumbEllipsis ersetzt die mittleren Einträge durch ein Auslassungszeichen; die erste und die letzte Ebene bleiben sichtbar. Das Auslassungszeichen ist nur ein Zeichen, kein Bedienelement.

Beispiel und Quelltext
gekuerzt.tsx
import Link from "next/link";

import {
  Breadcrumb,
  BreadcrumbEllipsis,
  BreadcrumbItem,
  BreadcrumbLink,
  BreadcrumbList,
  BreadcrumbPage,
  BreadcrumbSeparator,
} from "@neodin-eu/ui";

function Gekuerzt() {
  return (
    <Breadcrumb aria-label="Brotkrümelnavigation der Ticketliste">
      <BreadcrumbList>
        <BreadcrumbItem>
          <BreadcrumbLink asChild>
            <Link href="/docs">Start</Link>
          </BreadcrumbLink>
        </BreadcrumbItem>
        <BreadcrumbSeparator />
        <BreadcrumbItem>
          <BreadcrumbEllipsis />
        </BreadcrumbItem>
        <BreadcrumbSeparator />
        <BreadcrumbItem>
          <BreadcrumbLink asChild>
            <Link href="/docs/komponenten/navigation/brotkrumen">Tickets</Link>
          </BreadcrumbLink>
        </BreadcrumbItem>
        <BreadcrumbSeparator />
        <BreadcrumbItem>
          <BreadcrumbPage>#4711</BreadcrumbPage>
        </BreadcrumbItem>
      </BreadcrumbList>
    </Breadcrumb>
  );
}

Barrierefreiheit

  • Breadcrumb rendert ein nav-Element mit einem zugänglichen Namen aus dem Sprachkatalog: „Brotkrümelnavigation“ auf Deutsch, „Breadcrumb“ auf Englisch. Das ist im Komponententest abgesichert.
  • Der letzte Eintrag trägt aria-current="page"; die Links davor nicht. Der Komponententest prüft beides.
  • Trennzeichen und Auslassungszeichen sind mit aria-hidden ausgeblendet. Ein Screenreader liest den Pfad ohne Unterbrechung durch die Symbole.
  • BreadcrumbLink rendert ein a-Element. Damit gelten Tab und Enter wie bei jedem Link. Mit asChild gibst du das Kind-Element selbst vor, etwa den Link aus Next.js; der Komponententest prüft, dass das Kind samt href gerendert wird.
  • Der Fokus ist über focus-visible sichtbar. Der Komponententest prüft hell und dunkel ohne axe-Verstöße.

Props

Props von Breadcrumb
PropTypStandardPflichtBeschreibung
classNamestring–Nein–
Props von BreadcrumbList
PropTypStandardPflichtBeschreibung
classNamestring–Nein–
Props von BreadcrumbLink
PropTypStandardPflichtBeschreibung
asChildbooleanfalseNein–
classNamestring–Nein–
Props von BreadcrumbPage
PropTypStandardPflichtBeschreibung
classNamestring–Nein–

Siehe auch