# react-easy-breadcrumb

> A breadcrumb package for react.

Latest version **1.0.0** (published 2019-08-13) · ISC license · 0 weekly downloads

## Install

```sh
npm install react-easy-breadcrumb
pnpm add react-easy-breadcrumb
yarn add react-easy-breadcrumb
bun add react-easy-breadcrumb
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-08-13 |
| First published | 2019-08-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 269 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Biju Nakarmi |
| Maintainers | bijunakarmi |

## Links

- npm: https://www.npmjs.com/package/react-easy-breadcrumb
- npm.io page: https://npm.io/package/react-easy-breadcrumb

## Dependencies (1)

- [styled-components](https://npm.io/package/styled-components.md) ^4.3.2

## Recent versions

- 1.0.0 (latest) — 2019-08-13

## README

# react-easy-breadcrumb

A simple react component for generating breadcrumbs.

## Installation

```sh
npm install react-easy-breadcrumb
```

or

```sh
yarn add react-easy-breadcrumb
```

## `Breadcrumbs` component props

The breadcrumbs instance is implemented in the `Breadcrumbs` component.

| property    | type      | default     | description                         |
| ----------- | --------- | ----------- | ----------------------------------- |
| `separator` | _element_ | `>`         | separator between breadcrumbs items |
| `crumbs`    | array     | `undefined` | array of breadcrumbs items          |

## `crumbs` props

The crumbs property is array of breadcrumbs item that will be used in the `Breadcrumbs` component.

| property    | type                            | default        | description                                         |
| ----------- | ------------------------------- | -------------- | --------------------------------------------------- |
| `link`      | Link (eg: `https:/github.com/`) | `/`            | Link that is to be routed when clicked on the item. |
| `title`     | Text                            | `empty string` | The title that will be displayed as a crumb/item.   |
| `tintColor` | Color or hex value              | `#4a4a4a`      | Color that you want the item to display.            |

# Example

```javascript
import { Breadcrumbs } from 'react-easy-breadcrumb';
import Separator from '../images/separator.svg';

const links = [
	{
		link: 'http://github.com/',
		title: 'Home'
	},
	{
		link: 'http://google.com/',
		title: 'Profile',
		tintColor: '#3098'
	},
	{
		link: 'http://twitter.com/',
		title: 'Bookmarks',
		tintColor: 'red'
	}
];

const Page = (
	<div>
		<Breadcrumbs crumbs={links} separator={Separator} />
	</div>
);

export default Page;
```

### result

<img width="349" alt="Screen Shot 2019-08-13 at 3 14 10 PM" src="https://user-images.githubusercontent.com/12218329/62930967-31a79880-bddd-11e9-811d-875a4ed08853.png">

## LICENSE

#### [MIT](./LICENSE.md)

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