# ak-breadcrumbs

> A React component that allows users to know their location

Latest version **3.0.2** (published 2017-01-03) · Apache-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install ak-breadcrumbs
pnpm add ak-breadcrumbs
yarn add ak-breadcrumbs
bun add ak-breadcrumbs
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 3.0.2 |
| Published | 2017-01-03 |
| First published | 2016-11-29 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Atlassian Pty Ltd |
| Maintainers | atlassian-aui |
| Keywords | atlaskit, ui |

## Links

- npm: https://www.npmjs.com/package/ak-breadcrumbs
- Repository: https://bitbucket.org/atlassian/atlaskit
- Homepage: https://bitbucket.org/atlassian/atlaskit#readme
- npm.io page: https://npm.io/package/ak-breadcrumbs

## Dependencies (5)

- [ak-button](https://npm.io/package/ak-button.md) ^5.1.2
- [ak-tooltip](https://npm.io/package/ak-tooltip.md) ^6.0.3
- [classnames](https://npm.io/package/classnames.md) ^2.2.5
- [babel-runtime](https://npm.io/package/babel-runtime.md) ^6.11.6
- [akutil-shared-styles](https://npm.io/package/akutil-shared-styles.md) ^37.0.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 3.0.2 (latest) — 2017-01-03
- 3.0.1 — 2017-01-03
- 3.0.0 — 2016-12-16
- 2.0.0 — 2016-12-12
- 1.3.0 — 2016-12-08
- 1.2.0 — 2016-12-06
- 1.1.0 — 2016-12-05
- 1.0.1 — 2016-12-02
- 1.0.0 — 2016-11-29

## README

[![AtlasKit component registry](https://img.shields.io/badge/AtlasKit-components-FF5230.svg)](http://aui-cdn.atlassian.com/atlaskit/registry/)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://Commitizen.github.io/cz-cli/)
[![semantic-release](https://img.shields.io/badge/GitHub-semantic_release-ffab00.svg)](https://github.com/semantic-release/semantic-release)
[![Report an issue](https://img.shields.io/badge/Report-an_issue-6554C0.svg)](https://ecosystem.atlassian.net/browse/AK)
[![Ask in our forum](https://img.shields.io/badge/Ask-in_our_forum-6554C0.svg)](https://answers.atlassian.com/questions/ask?title=AtlasKit%3A%20&topics=atlaskit,ak-breadcrumbs,ak-breadcrumbs@3.0.2)

# Breadcrumbs

Breadcrumbs help users visualize their current location in relation to the rest of the website or application by showing the hierarchy of pages.

## Try it out

Interact with a [live demo of the ak-breadcrumbs component with code examples](https://aui-cdn.atlassian.com/atlaskit/stories/ak-breadcrumbs/3.0.2/).

## Installation

```sh
npm install ak-breadcrumbs
```

## Using the component

### React

This is a standard React component.

```js
import AkBreadcrumbs, { AkBreadcrumbsItem } from 'ak-breadcrumbs';

ReactDOM.render(
  <AkBreadcrumbs>
    <AkBreadcrumbsItem href="/home" text="Home" />
    <AkBreadcrumbsItem href="/home/item" text="Item" />
  </AkBreadcrumbs>,
  container
);
```

## Classes

<dl>
<dt><a href="#Breadcrumbs">Breadcrumbs</a></dt>
<dd></dd>
<dt><a href="#BreadcrumbsItem">BreadcrumbsItem</a></dt>
<dd></dd>
</dl>

<a name="Breadcrumbs"></a>

## Breadcrumbs
**Kind**: global class  
* Properties

    *  [breadcrumbs.isExpanded](#Breadcrumbs+isExpanded) : <code>boolean</code>
    *  [breadcrumbs.maxItems](#Breadcrumbs+maxItems) : <code>number</code>
    *  [breadcrumbs.onExpand](#Breadcrumbs+onExpand) : <code>function</code>
    *  [breadcrumbs.children](#Breadcrumbs+children) : <code>node</code> &#124; <code>Array.&lt;node&gt;</code>

<a name="new_Breadcrumbs_new"></a>

### new Breadcrumbs()
Breadcrumbs React component.

The Breadcrumbs component will render a list of slash-separated breadcrumb items, and will
automatically truncate the list if there are more than 8 items.

**JS Example**
```js
import Breadcrumbs from 'ak-breadcrumbs';
ReactDOM.render(<Breadcrumbs />);
```
<a name="Breadcrumbs+isExpanded"></a>

### breadcrumbs.isExpanded : <code>boolean</code>
Whether the breadcrumbs should be expanded when there are 9 or more items.

If this is true, the breadcrumbs will not collapse and show an ellipsis item.

**Kind**: instance property of <code>[Breadcrumbs](#Breadcrumbs)</code>  
**Default**: <code>false</code>  
<a name="Breadcrumbs+maxItems"></a>

### breadcrumbs.maxItems : <code>number</code>
The maximum number of items to display before automatically collapsing the
list of breadcrumbs.

**Kind**: instance property of <code>[Breadcrumbs](#Breadcrumbs)</code>  
**Default**: <code>8</code>  
<a name="Breadcrumbs+onExpand"></a>

### breadcrumbs.onExpand : <code>function</code>
Callback that is called when the ellipsis expander item is selected.

**Kind**: instance property of <code>[Breadcrumbs](#Breadcrumbs)</code>  
**Required**:   
<a name="Breadcrumbs+children"></a>

### breadcrumbs.children : <code>node</code> &#124; <code>Array.&lt;node&gt;</code>
The items to display.

If there are more than the number of items specified by `maxItems`, the list will
automatically be truncated to display only the first and last items. Clicking the ellipsis
separator item will display all the items.

**Kind**: instance property of <code>[Breadcrumbs](#Breadcrumbs)</code>  
<a name="BreadcrumbsItem"></a>

## BreadcrumbsItem
**Kind**: global class  
* Properties

    *  [breadcrumbsItem.href](#BreadcrumbsItem+href) : <code>string</code>
    *  [breadcrumbsItem.text](#BreadcrumbsItem+text) : <code>string</code>
    *  [BreadcrumbsItem.iconBefore](#BreadcrumbsItem.iconBefore) : <code>element</code>
    *  [BreadcrumbsItem.iconAfter](#BreadcrumbsItem.iconAfter) : <code>element</code>

<a name="new_BreadcrumbsItem_new"></a>

### new BreadcrumbsItem()
BreadcrumbsItem React component.

**JS Example**
```js
import { AkBreadcrumbsItem } from 'ak-breadcrumbs';
ReactDOM.render(<AkBreadcrumbsItem href="/item">Item</AkBreadcrumbsItem);
```
<a name="BreadcrumbsItem+href"></a>

### breadcrumbsItem.href : <code>string</code>
The target URL.

**Kind**: instance property of <code>[BreadcrumbsItem](#BreadcrumbsItem)</code>  
<a name="BreadcrumbsItem+text"></a>

### breadcrumbsItem.text : <code>string</code>
The text content of the item.

**Kind**: instance property of <code>[BreadcrumbsItem](#BreadcrumbsItem)</code>  
<a name="BreadcrumbsItem.iconBefore"></a>

### BreadcrumbsItem.iconBefore : <code>element</code>
The icon to display before the item content.
Icons specified in this way will always be displayed, even when the content is truncated.

**Kind**: static property of <code>[BreadcrumbsItem](#BreadcrumbsItem)</code>  
<a name="BreadcrumbsItem.iconAfter"></a>

### BreadcrumbsItem.iconAfter : <code>element</code>
The icon to display after the item content.
Icons specified in this way will always be displayed, even when the content is truncated.

**Kind**: static property of <code>[BreadcrumbsItem](#BreadcrumbsItem)</code>  

## Support and feedback

### We're here to help!

Let us know what you think of our components and docs, your feedback is really important for us.

### Community support

Ask a question in our [forum](https://answers.atlassian.com/questions/ask?title=AtlasKit%3A%20&topics=atlaskit,ak-breadcrumbs,ak-breadcrumbs@3.0.2).

Check [if someone has already asked the same question before](https://answers.atlassian.com/questions/topics/42926171/atlaskit).


### Create a support ticket

Are you in trouble? [Let us know](https://ecosystem.atlassian.net/browse/AK)!

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