All components · Category: Navigation

Breadcrumb trail

The path to the current page, collapsing its middle when it is long.

An ordered list of links with chevron separators drawn in code. A long path folds its middle into one button that says how many pages it hides and expands them. The last crumb is marked as the current page for screen readers.

Try it

<breadcrumb-trail>

ViewPreviewCodeCSS

breadcrumb-trail: The path to the current page, collapsing its middle when it is long. A picture of the real component, drawn from its own code. The controls change the picture and the code beside it; nothing here is sent or stored.

Generated from the component's manifest and the values above.

index.html

<breadcrumb-trail locale="en"></breadcrumb-trail>

<script>
  const element = document.querySelector("breadcrumb-trail");
  element.addEventListener("breadcrumb-trail:expanded", (event) => {
    console.log(event.detail);
  });
</script>

Add the site's Taggor script once; the component appears when it loads.

taggor-component.js

const element = document.createElement("breadcrumb-trail");
element.setAttribute("locale", "en");
element.addEventListener("breadcrumb-trail:expanded", (event) => {
  console.log(event.detail);
});
document.body.append(element);

Add the site's Taggor script once; the component appears when it loads.

BreadcrumbTrail.tsx

import { useEffect, useRef } from "react";

export function BreadcrumbTrail() {
  const ref = useRef<HTMLElement>(null);

  useEffect(() => {
    const element = ref.current;
    if (!element) return;
    const onExpanded = (event: Event) => {
      console.log((event as CustomEvent).detail);
    };
    element.addEventListener("breadcrumb-trail:expanded", onExpanded);
    return () => {
      element.removeEventListener("breadcrumb-trail:expanded", onExpanded);
    };
  }, []);

  return <breadcrumb-trail ref={ref} locale="en" />;
}

Add the site's Taggor script once; the component appears when it loads.
React 18 sends every prop of a custom element as a text attribute.
The event is heard with addEventListener, inside an effect.

BreadcrumbTrail.tsx

import { useEffect, useRef } from "react";

export function BreadcrumbTrail() {
  const ref = useRef<HTMLElement>(null);

  useEffect(() => {
    const element = ref.current;
    if (!element) return;
    const onExpanded = (event: Event) => {
      console.log((event as CustomEvent).detail);
    };
    element.addEventListener("breadcrumb-trail:expanded", onExpanded);
    return () => {
      element.removeEventListener("breadcrumb-trail:expanded", onExpanded);
    };
  }, []);

  return <breadcrumb-trail ref={ref} locale="en" />;
}

Add the site's Taggor script once; the component appears when it loads.
React 19 sets a property when the element already has it, an attribute otherwise.
The event is heard with addEventListener, inside an effect.

src/BreadcrumbTrail.vue

<script setup lang="ts">
function onExpanded(event: Event) {
  console.log((event as CustomEvent).detail);
}
</script>

<template>
  <breadcrumb-trail locale="en" @breadcrumb-trail:expanded="onExpanded" />
</template>

vite.config.ts

import vue from "@vitejs/plugin-vue";
import { defineConfig } from "vite";

export default defineConfig({
  plugins: [
    vue({
      template: {
        compilerOptions: {
          isCustomElement: (tag) => tag === "breadcrumb-trail",
        },
      },
    }),
  ],
});

Add the site's Taggor script once; the component appears when it loads.
vite.config.ts tells Vue that this tag is not a Vue component.

src/app/breadcrumb-trail.component.ts

import { afterNextRender, Component, CUSTOM_ELEMENTS_SCHEMA, DestroyRef, ElementRef, inject } from "@angular/core";

@Component({
  selector: "app-breadcrumb-trail",
  schemas: [CUSTOM_ELEMENTS_SCHEMA],
  template: `
    <breadcrumb-trail locale="en"></breadcrumb-trail>
  `,
})
export class BreadcrumbTrailComponent {
  constructor() {
    const host = inject<ElementRef<HTMLElement>>(ElementRef);
    const element = () => host.nativeElement.querySelector("breadcrumb-trail");
    const onExpanded = (event: Event) => {
      console.log((event as CustomEvent).detail);
    };
    afterNextRender(() => element()?.addEventListener("breadcrumb-trail:expanded", onExpanded));
    inject(DestroyRef).onDestroy(() => element()?.removeEventListener("breadcrumb-trail:expanded", onExpanded));
  }
}

Add the site's Taggor script once; the component appears when it loads.
The component declares CUSTOM_ELEMENTS_SCHEMA.
The event is heard with addEventListener, inside an effect.

src/TaggorComponent.svelte

<script>
  function onExpanded(event) {
    console.log(event.detail);
  }
</script>

<breadcrumb-trail locale="en" onbreadcrumb-trail:expanded={onExpanded}></breadcrumb-trail>

Add the site's Taggor script once; the component appears when it loads.

How an agent gets a component like this onto a site:

taggor checktaggor publish

The CSS variables the component exposes, set the way a customer's page would.

styles.css

breadcrumb-trail {
  --bt-radius: 999px;
}

Props

Props of the component, read from its manifest
Prop	Type	Default	What it does
crumbs	list	none	The path, first to last; the last one is the current page.
max	number 2 to 8	4	The most crumbs shown before the middle collapses.
locale	pt-BR \| en	en	–

Prop names and descriptions are the component's own, in English, as its author wrote them.

Events

Events of the component, read from its manifest
Event	When it fires
expanded	The hidden crumbs were shown.

Build one with your agent

Build me a Taggor component like "Breadcrumb trail" (breadcrumb-trail): The path to the current page, collapsing its middle when it is long. Fetch https://taggor.dev/agent-setup/prompt.md and follow its instructions to set me up for Taggor. Ask me before you sign in, create an account, accept terms, pay for anything or type a secret. Check it with `taggor check` and publish it with `taggor publish`, and stop there. Do not promote it to production, attach it to a site, roll back anything or use --yes, --force or --force-drop-invalid unless I ask for exactly that in this conversation.

Related components

Mega menu<nav-mega-menu>
Gliding tabs<tabs-glide>
Shrinking header<nav-shrink-header>