Zubra UI
Code for
GitHub

breadcrumb-trail

Where this page sits: a trail of links from the top, ending at the current page (marked aria-current="page", not a link). items is [{ label, href }]; the last is the current page.

This one has no events: it shows what it's given.

Source: breadcrumb-trail.zb, and its registry item.

Install

Compiled (any project)
npx shadcn@latest add https://zubra-js.github.io/zubra-ui/r/breadcrumb-trail.jsonpnpm dlx shadcn@latest add https://zubra-js.github.io/zubra-ui/r/breadcrumb-trail.jsonyarn dlx shadcn@latest add https://zubra-js.github.io/zubra-ui/r/breadcrumb-trail.jsonbunx --bun shadcn@latest add https://zubra-js.github.io/zubra-ui/r/breadcrumb-trail.json
One file, no dependencies (2.8 KB gzipped)
npx shadcn@latest add https://zubra-js.github.io/zubra-ui/r/element/breadcrumb-trail.jsonpnpm dlx shadcn@latest add https://zubra-js.github.io/zubra-ui/r/element/breadcrumb-trail.jsonyarn dlx shadcn@latest add https://zubra-js.github.io/zubra-ui/r/element/breadcrumb-trail.jsonbunx --bun shadcn@latest add https://zubra-js.github.io/zubra-ui/r/element/breadcrumb-trail.json
.zb source (to edit it with Zubra)
npx shadcn@latest add https://zubra-js.github.io/zubra-ui/r/src/breadcrumb-trail.jsonpnpm dlx shadcn@latest add https://zubra-js.github.io/zubra-ui/r/src/breadcrumb-trail.jsonyarn dlx shadcn@latest add https://zubra-js.github.io/zubra-ui/r/src/breadcrumb-trail.jsonbunx --bun shadcn@latest add https://zubra-js.github.io/zubra-ui/r/src/breadcrumb-trail.json
No build: a script tag, straight from this site
HTML
<link rel="stylesheet" href="https://zubra-js.github.io/zubra-ui/themes/default.css">
<script type="module" src="https://zubra-js.github.io/zubra-ui/cdn/breadcrumb-trail.js"></script>

The compiled install writes src/components/zubra/breadcrumb-trail.js and the theme, and adds @zubra/runtime to your dependencies. The one-file install writes the same path as a plain custom element that needs nothing installed (or download it and load it with a <script type="module">); it's smaller on a page with one to three components, the shared runtime with more.

Usage

index.html
<breadcrumb-trail></breadcrumb-trail>

<script type="module">
  import './components/zubra/breadcrumb-trail.js';

  const element = document.querySelector('breadcrumb-trail');
  element.items = [
    { label: 'Home', href: '#home' },
    { label: 'Recipes', href: '#recipes' },
    { label: 'Breads', href: '#breads' },
    { label: 'Sourdough' },
  ];
</script>
Example.jsx
import './components/zubra/breadcrumb-trail.js';

const items = [
  { label: 'Home', href: '#home' },
  { label: 'Recipes', href: '#recipes' },
  { label: 'Breads', href: '#breads' },
  { label: 'Sourdough' },
];

export function BreadcrumbTrailExample() {
  return (
    <breadcrumb-trail items={items}></breadcrumb-trail>
  );
}
Example.vue
<script setup>
import './components/zubra/breadcrumb-trail.js';
const items = [
  { label: 'Home', href: '#home' },
  { label: 'Recipes', href: '#recipes' },
  { label: 'Breads', href: '#breads' },
  { label: 'Sourdough' },
];
</script>

<template>
  <breadcrumb-trail :items.prop="items"></breadcrumb-trail>
</template>

<!-- vite.config.js: vue({ template: { compilerOptions: { isCustomElement: (tag) => tag.includes('-') } } }) -->
Example.svelte
<script>
  import './components/zubra/breadcrumb-trail.js';
  const items = [
    { label: 'Home', href: '#home' },
    { label: 'Recipes', href: '#recipes' },
    { label: 'Breads', href: '#breads' },
    { label: 'Sourdough' },
  ];
</script>

<breadcrumb-trail {items}></breadcrumb-trail>
example.component.ts
import { Component, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
import './components/zubra/breadcrumb-trail.js';

@Component({
  selector: 'app-breadcrumb-trail-example',
  schemas: [CUSTOM_ELEMENTS_SCHEMA],
  template: `
    <breadcrumb-trail [items]="items"></breadcrumb-trail>
  `,
})
export class BreadcrumbTrailExample {
  items = [
    { label: 'Home', href: '#home' },
    { label: 'Recipes', href: '#recipes' },
    { label: 'Breads', href: '#breads' },
    { label: 'Sourdough' },
  ];
}

API

Properties (each is also an HTML attribute of the same name, unless marked)
PropertyTypeDefault
items
property only
{ label, href }[][]
labelstring"Breadcrumb"

Size

0.9 KB gzipped for the component, plus the runtime, which every Zubra component on a page shares (up to 22.1 KB, all of it). On its own, with the parts of the runtime it uses, it's 17.1 KB.

Theme

Every component reads shadcn/ui's CSS variables, so any shadcn theme works. Pick a look or a colour, or paste a theme's CSS.

Look: colours, fonts, corners and motion

Accent colour