Breadcrumbs
kumo-svelte
<script lang="ts">
  import { Breadcrumbs } from 'kumo-svelte/components/breadcrumbs';
  import House from 'phosphor-svelte/lib/House';
</script>

<Breadcrumbs>
  <Breadcrumbs.Link href="#" icon={House}>Home</Breadcrumbs.Link>
  <Breadcrumbs.Separator />
  <Breadcrumbs.Link href="#">Projects</Breadcrumbs.Link>
  <Breadcrumbs.Separator />
  <Breadcrumbs.Current>Current Project</Breadcrumbs.Current>
</Breadcrumbs>

Installation

Barrel

import { Breadcrumbs } from 'kumo-svelte';

Granular

import { Breadcrumbs } from 'kumo-svelte/components/breadcrumbs';

Usage

<script lang="ts">
  import { Breadcrumbs } from 'kumo-svelte/components/breadcrumbs';
</script>

<Breadcrumbs>
  <Breadcrumbs.Link href="#">Home</Breadcrumbs.Link>
  <Breadcrumbs.Separator />
  <Breadcrumbs.Link href="#">Docs</Breadcrumbs.Link>
  <Breadcrumbs.Separator />
  <Breadcrumbs.Current>Breadcrumbs</Breadcrumbs.Current>
</Breadcrumbs>

Examples

Basic

<script lang="ts">
  import { Breadcrumbs } from 'kumo-svelte/components/breadcrumbs';
</script>

<Breadcrumbs>
  <Breadcrumbs.Link href="#">Home</Breadcrumbs.Link>
  <Breadcrumbs.Separator />
  <Breadcrumbs.Link href="#">Docs</Breadcrumbs.Link>
  <Breadcrumbs.Separator />
  <Breadcrumbs.Current>Breadcrumbs</Breadcrumbs.Current>
</Breadcrumbs>

Loading

<script lang="ts">
  import { Breadcrumbs } from 'kumo-svelte/components/breadcrumbs';
  import House from 'phosphor-svelte/lib/House';
</script>

<Breadcrumbs>
  <Breadcrumbs.Link href="#" icon={House}>Home</Breadcrumbs.Link>
  <Breadcrumbs.Separator />
  <Breadcrumbs.Link href="#">Docs</Breadcrumbs.Link>
  <Breadcrumbs.Separator />
  <Breadcrumbs.Current loading />
</Breadcrumbs>

Root

<script lang="ts">
  import { Breadcrumbs } from 'kumo-svelte/components/breadcrumbs';
  import House from 'phosphor-svelte/lib/House';
</script>

<Breadcrumbs>
  <Breadcrumbs.Current icon={House}>Worker Analytics</Breadcrumbs.Current>
</Breadcrumbs>

Clipboard

<script lang="ts">
  import { Breadcrumbs } from 'kumo-svelte/components/breadcrumbs';
</script>

<Breadcrumbs>
  <Breadcrumbs.Link href="#">Home</Breadcrumbs.Link>
  <Breadcrumbs.Separator />
  <Breadcrumbs.Current>Breadcrumbs</Breadcrumbs.Current>
  <Breadcrumbs.Clipboard text="#" />
</Breadcrumbs>

Localization

Use KumoLocaleProvider to translate the breadcrumb landmark name (breadcrumbs.label), the clipboard button name (breadcrumbs.copy), and its tooltip (breadcrumbs.copyTooltip). The default strings are “breadcrumb”, “Copy”, and “Click to copy”.

Pass aria-label to Breadcrumbs to override the landmark name for an individual trail. In a container with dir="rtl", the separators point left and the trail’s end margin moves to the left.

<script lang="ts">
  import { KumoLocaleProvider } from 'kumo-svelte';
  import { Breadcrumbs } from 'kumo-svelte/components/breadcrumbs';
</script>

<div dir="rtl" lang="ar">
  <KumoLocaleProvider
    translations={{
      breadcrumbs: {
        label: 'مسار التنقل',
        copy: 'نسخ',
        copyTooltip: 'انقر للنسخ'
      }
    }}
  >
    <Breadcrumbs>
      <Breadcrumbs.Link href="/">الرئيسية</Breadcrumbs.Link>
      <Breadcrumbs.Separator />
      <Breadcrumbs.Current>المستندات</Breadcrumbs.Current>
      <Breadcrumbs.Clipboard text="/components/breadcrumbs" />
    </Breadcrumbs>
  </KumoLocaleProvider>
</div>

API Reference

PropTypeDefaultDescription
size 'sm' | 'base'"base"Size of the breadcrumbs.
children Snippet-Breadcrumbs.Link, Breadcrumbs.Separator, Breadcrumbs.Current, and Breadcrumbs.Clipboard children.
class string-Additional classes merged onto the nav element.
PropTypeDefaultDescription
href *string-Destination URL.
icon Component-Icon component rendered before the label.
PropTypeDefaultDescription
icon Component-Icon component rendered before the label.
loading booleanfalseShows a skeleton placeholder instead of the label.
PropTypeDefaultDescription
No component-specific props. Accepts standard HTML attributes.
PropTypeDefaultDescription
text *string-Text copied to the clipboard.