Skip to content
v0.2.10

Breadcrumb

A wrapping hierarchy of native links with an explicit current page.

Preview

Use Breadcrumb

Breadcrumb is a named export of @flood-md/react. Connect the package once, then import what you use.

First time here? Connect Flood
Example import style
breadcrumb.tsxTSX
"use client";

import { FloodRoot, Breadcrumb } from "@flood-md/react";
import "@flood-md/react/styles.css";

export function Example() {
  return (
    <FloodRoot>
      <Breadcrumb items={[{label:"Workspace",href:"/"},{label:"Projects",href:"/projects"},{label:"Flood"}]} />
    </FloodRoot>
  );
}

Design notes

  • The last item is current, with or without an href. Separators are decorative and not focusable.
  • Links keep browser navigation semantics. The host owns actual routes and client routing.

API reference

PropValuesDefault
itemsreadonly BreadcrumbItem[]Required
labelstring"Breadcrumb"
separatorstring"/"
Native HTML propsOmit<HTMLAttributes<HTMLElement>, "children">Forwarded
View TypeScript source