Docs Components Navigation

Breadcrumb

React example follows below.
ts
const breadcrumbFixture = {
id: "breadcrumb",
separator: "/",
items: [
{ label: "projects", href: "/projects" },
{ label: "ledger-api", href: "/projects/ledger-api" },
{ label: "deployments" },
],
} satisfies { id: string; separator: string; items: Array<{ label: string; href?: string }> };
import { Breadcrumb } from "@grassroot/ui-react";
export default function BreadcrumbDemo() {
return (
<div>
<Breadcrumb items={breadcrumbFixture.items} separator={breadcrumbFixture.separator} />
</div>
);
}
ts
<script setup lang="ts">
import { Breadcrumb } from "@grassroot/ui-vue";
const breadcrumbFixture = {
id: "breadcrumb",
separator: "/",
items: [
{ label: "projects", href: "/projects" },
{ label: "ledger-api", href: "/projects/ledger-api" },
{ label: "deployments" },
],
} satisfies { id: string; separator: string; items: Array<{ label: string; href?: string }> };
</script>
<template>
<div>
<Breadcrumb :items="breadcrumbFixture.items" :separator="breadcrumbFixture.separator" />
</div>
</template>
ts
import { Component } from "@angular/core";
import { GrassrootBreadcrumb } from "@grassroot/ui-angular";
const breadcrumbFixture = {
id: "breadcrumb",
separator: "/",
items: [
{ label: "projects", href: "/projects" },
{ label: "ledger-api", href: "/projects/ledger-api" },
{ label: "deployments" },
],
} satisfies { id: string; separator: string; items: Array<{ label: string; href?: string }> };
@Component({
selector: "app-breadcrumb-demo",
standalone: true,
imports: [GrassrootBreadcrumb],
template: `
<div>
<grassroot-breadcrumb [items]="fixture.items" [separator]="fixture.separator" />
</div>
`,
})
export class BreadcrumbDemoComponent {
protected readonly fixture = breadcrumbFixture;
}
export default BreadcrumbDemoComponent;
ts
<script lang="ts">
import { Breadcrumb } from "@grassroot/ui-svelte";
const breadcrumbFixture = {
id: "breadcrumb",
separator: "/",
items: [
{ label: "projects", href: "/projects" },
{ label: "ledger-api", href: "/projects/ledger-api" },
{ label: "deployments" },
],
} satisfies { id: string; separator: string; items: Array<{ label: string; href?: string }> };
</script>
<div>
<Breadcrumb items={breadcrumbFixture.items} separator={breadcrumbFixture.separator} />
</div>
ts
/** @jsxImportSource solid-js */
import { Breadcrumb } from "@grassroot/ui-solid";
const breadcrumbFixture = {
id: "breadcrumb",
separator: "/",
items: [
{ label: "projects", href: "/projects" },
{ label: "ledger-api", href: "/projects/ledger-api" },
{ label: "deployments" },
],
} satisfies { id: string; separator: string; items: Array<{ label: string; href?: string }> };
import type { JSX } from "solid-js";
export default function BreadcrumbDemo(): JSX.Element {
return (
<div>
<Breadcrumb items={breadcrumbFixture.items} separator={breadcrumbFixture.separator} />
</div>
);
}

Installation

API Reference

Import

import { Breadcrumb } from "@grassroot/ui-react";

Props

Prop
Type
Default
Requirement
items
CrumbItem[]
required
Prop
items
Type
CrumbItem[]
Default
Requirement
required

Content regions

  • separator

Native attributes

Standard DOM and ARIA attributes not listed above spread onto the root element.

Import

import { Breadcrumb } from "@grassroot/ui-vue";

Props

Prop
Type
Default
Requirement
items
CrumbItem[]
required
separator
string | undefined
"/"
optional
Prop
items
Type
CrumbItem[]
Default
Requirement
required
Prop
separator
Type
string | undefined
Default
"/"
Requirement
optional

Content regions

  • default
  • separator

Import

import { Component } from "@angular/core";
import { GrassrootBreadcrumb } from "@grassroot/ui-angular";

Props

Prop
Type
Default
Requirement
items
CrumbItem[]
required
separator
string
"/"
optional
Prop
items
Type
CrumbItem[]
Default
Requirement
required
Prop
separator
Type
string
Default
"/"
Requirement
optional

Import

import { Breadcrumb } from "@grassroot/ui-svelte";

Props

Prop
Type
Default
Requirement
items
CrumbItem[]
required
className
string
optional
Prop
items
Type
CrumbItem[]
Default
Requirement
required
Prop
className
Type
string
Default
Requirement
optional

Content regions

  • children
  • separator

Import

import { Breadcrumb } from "@grassroot/ui-solid";
import type { JSX } from "solid-js";

Props

Prop
Type
Default
Requirement
items
CrumbItem[]
required
className
string
optional
Prop
items
Type
CrumbItem[]
Default
Requirement
required
Prop
className
Type
string
Default
Requirement
optional

Content regions

  • separator