# @ds-kit/breadcrumbs

> Breadcrumbs component

Latest version **1.1.0** (published 2019-08-22) · LicenseRef-LICENSE license · 0 weekly downloads

## Install

```sh
npm install @ds-kit/breadcrumbs
pnpm add @ds-kit/breadcrumbs
yarn add @ds-kit/breadcrumbs
bun add @ds-kit/breadcrumbs
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2019-08-22 |
| First published | 2019-08-09 |
| Weekly downloads | 0 |
| License | LicenseRef-LICENSE |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 15.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | LapidusInteractive |
| Maintainers | amytych, lapidus, zimrick |

## Links

- npm: https://www.npmjs.com/package/@ds-kit/breadcrumbs
- npm.io page: https://npm.io/package/@ds-kit/breadcrumbs

## Dependencies (2)

- [@ds-kit/div](https://npm.io/package/@ds-kit/div.md) ^4.1.0
- [@ds-kit/icon](https://npm.io/package/@ds-kit/icon.md) ^4.1.0

## Recent versions

- 1.1.0 (latest) — 2019-08-22
- 1.0.0 — 2019-08-09

## README

---
title: "Breadcrumbs"
slug: "/packages/breadcrumbs"
category: "control"
componentNames:
  - "Breadcrumbs"
---

# Breadcrumbs

Breadcrumbs can be used to show users where they are within the datastory page hierarchy.

```js
import Breadcrumbs from "@ds-kit/breadcrumbs"
```

## Basic Example

The most basic breadcrumbs component returns a `nav` with `aria-label="Breadcrumbs"` and an ordered list of navigation items. For each item the component renders a link. The last item has an `aria-current="page"` attribute.

```jsx
<Breadcrumbs
  links={[
    { key: 1, href: "/", label: "Home" },
    { key: 2, href: "/patterns", label: "Patterns" },
    { key: 3, href: "/patterns/blog-post", label: "Blog post pattern" },
  ]}
/>
```

## Custom Links

To use the breadcrumbs component with a framework like next.js or gatsby, you can use the `link` prop to hook up a custom link component.

```jsx
<Breadcrumbs
  links={[
    { href: "/", label: "Home" },
    { href: "/patterns", label: "Patterns" },
    { href: "/patterns/blog-post", label: "Blog post pattern" },
  ]}
  link={({ label, href }) =>
    <a href={href}>{label}</a>
  }
/>
```

---
_Source: https://npm.io/package/@ds-kit/breadcrumbs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._