# Breadcrumb

> Shows where a page sits and links back to its parents.

A breadcrumb shows the path from a section to the current page, and links each step back.

## When to use

- Use it on pages two or more levels deep, such as the metadata of one release.
- Put it above the page title. The [Detail](https://design.sosialoka.tech/patterns/detail/) pattern shows it in place.
- Don't use it on top-level pages; the sidebar already says where you are.

_Live preview of the React and Vue versions: https://design.sosialoka.tech/components/breadcrumb/_

## Anatomy

1. Link to a parent page
2. Separator
3. Current page

Links in `text-sm text-muted-foreground`, separated by a 14px chevron. The current page is the last item, in `text-foreground font-medium`, and is not a link. Below `sm`, collapse the middle levels into an ellipsis.

## Variants

There is one style.

## Props

| React | Vue | Flutter | Type | Default | Use |
| --- | --- | --- | --- | --- | --- |
| `BreadcrumbLink href` | `BreadcrumbLink href` | `ShadBreadcrumbLink onPressed` | link | none | A parent page. |
| `BreadcrumbPage` | `BreadcrumbPage` | `Text` | text | none | The current page, not a link. |
| `BreadcrumbSeparator` | `BreadcrumbSeparator` | `separator` | element | chevron | The mark between steps. |
| `BreadcrumbEllipsis` | `BreadcrumbEllipsis` | `ShadBreadcrumbEllipsis` | element | none | Stands for hidden middle levels. |

## Code

**React**
```tsx
import {
  Breadcrumb,
  BreadcrumbItem,
  BreadcrumbLink,
  BreadcrumbList,
  BreadcrumbPage,
  BreadcrumbSeparator,
} from "@/components/ui/breadcrumb"

export default function BreadcrumbDemo() {
  return (
    <Breadcrumb>
      <BreadcrumbList>
        <BreadcrumbItem>
          <BreadcrumbLink href="#">Rilis</BreadcrumbLink>
        </BreadcrumbItem>
        <BreadcrumbSeparator />
        <BreadcrumbItem>
          <BreadcrumbLink href="#">Senja di Kota</BreadcrumbLink>
        </BreadcrumbItem>
        <BreadcrumbSeparator />
        <BreadcrumbItem>
          <BreadcrumbPage>Ubah metadata</BreadcrumbPage>
        </BreadcrumbItem>
      </BreadcrumbList>
    </Breadcrumb>
  )
}
```

**Vue**
```vue
<script setup lang="ts">
import {
  Breadcrumb,
  BreadcrumbItem,
  BreadcrumbLink,
  BreadcrumbList,
  BreadcrumbPage,
  BreadcrumbSeparator,
} from "@/components/ui/breadcrumb"
</script>

<template>
  <Breadcrumb>
    <BreadcrumbList>
      <BreadcrumbItem>
        <BreadcrumbLink href="#">Rilis</BreadcrumbLink>
      </BreadcrumbItem>
      <BreadcrumbSeparator />
      <BreadcrumbItem>
        <BreadcrumbLink href="#">Senja di Kota</BreadcrumbLink>
      </BreadcrumbItem>
      <BreadcrumbSeparator />
      <BreadcrumbItem>
        <BreadcrumbPage>Ubah metadata</BreadcrumbPage>
      </BreadcrumbItem>
    </BreadcrumbList>
  </Breadcrumb>
</template>
```

**Flutter**
```dart
import 'package:flutter/widgets.dart';
import 'package:shadcn_ui/shadcn_ui.dart';

class BreadcrumbDemo extends StatelessWidget {
  const BreadcrumbDemo({super.key});

  @override
  Widget build(BuildContext context) {
    return ShadBreadcrumb(
      children: [
        ShadBreadcrumbLink(onPressed: () {}, child: const Text('Rilis')),
        ShadBreadcrumbLink(onPressed: () {}, child: const Text('Senja di Kota')),
        // The current page is plain text, not a link.
        Semantics(selected: true, child: const Text('Ubah metadata')),
      ],
    );
  }
}
```

## Install

**React**
```bash
npx shadcn@latest add https://design.sosialoka.tech/r/react/breadcrumb.json
```

**Vue**
```bash
npx shadcn-vue@latest add https://design.sosialoka.tech/r/vue/breadcrumb.json
```

## Accessibility

- The breadcrumb is a `nav` named "breadcrumb", with the steps in an ordered list.
- The current page has `aria-current="page"`.
- Separators are hidden from screen readers.
