# material-ui-breadcrumbs

> Breadcrumbs component for React integrated with material-ui package.

Latest version **0.1.6** (published 2018-01-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install material-ui-breadcrumbs
pnpm add material-ui-breadcrumbs
yarn add material-ui-breadcrumbs
bun add material-ui-breadcrumbs
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.6 |
| Published | 2018-01-15 |
| First published | 2018-01-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=6.10.0 |
| Dependencies | 8 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Anatolii Hordiienko |
| Maintainers | tolig |

## Links

- npm: https://www.npmjs.com/package/material-ui-breadcrumbs
- Repository: https://github.com/gordienkotolik/material-ui-breadcrumbs
- Homepage: https://gasite.in.ua/open-source/material-ui-breadcrumbs/
- Issues: https://github.com/gordienkotolik/material-ui-breadcrumbs/issues
- npm.io page: https://npm.io/package/material-ui-breadcrumbs

## Dependencies (8)

- [react](https://npm.io/package/react.md) 16.2.0
- [react-dom](https://npm.io/package/react-dom.md) 16.2.0
- [prop-types](https://npm.io/package/prop-types.md) 15.6.0
- [material-ui](https://npm.io/package/material-ui.md) 0.20.0
- [react-router](https://npm.io/package/react-router.md) 4.2.0
- [react-router-dom](https://npm.io/package/react-router-dom.md) 4.2.2
- [react-router-config](https://npm.io/package/react-router-config.md) 1.0.0-beta.4
- [react-addons-create-fragment](https://npm.io/package/react-addons-create-fragment.md) 15.6.2

## Recent versions

- 0.1.6 (latest) — 2018-01-15
- 0.1.5 — 2018-01-15
- 0.1.4 — 2018-01-15
- 0.1.3 — 2018-01-15
- 0.1.2 — 2018-01-15
- 0.1.1 — 2018-01-15
- 0.1.0 — 2018-01-15

## README

material-ui-breadcrumbs
=======================

## [Material-UI Breadcrumbs](https://github.com/gordienkotolik/material-ui-breadcrumbs)

Breadcrumbs component for React integrated with material-ui package.


## Requirements

- [React](https://reactjs.org/) 16.2.0 (not tested on other versions)
- [Material-UI](http://www.material-ui.com) 0.20.0 (not tested on other versions)


## Required Knowledge

I recommend that you get to know [React](http://facebook.github.io/react/) and [Material-UI](http://material-ui.com/).

## Installation
```sh
npm i material-ui-breadcrumbs --save
```
or
```sh
yarn add material-ui-breadcrumbs
```

## Usage
Once installed, just import and use the component:
```javascript
import React from 'react';
import {Breadcrumbs} from 'material-ui-breadcrumbs/Breadcrumbs';

const className = 'custom-class';
const style = {
  width: '50%',
  height: '48px',
};

export const Example = () => (
  <Breadcrumbs
    className={className}
    style={style}
    transparentBackground={true}
  />
);

export default Example;
```


#### Properties
| Props        | Options           | Default  | Description |
| ------------- |-------------| -----| -------- |
| className | String | '' | Adds custom class to breadcrumbs container.|
| style | Object | {} | Adds custom inline styles to breadcrumbs container. |
| itemClassName | String | '' | Adds custom class to breadcrumbs item.|
| itemStyle | Object | {} | Adds custom inline styles to breadcrumbs item. |
| activeItemClassName | String | '' | Adds custom class to active breadcrumbs item.|
| activeItemStyle | Object | {} | Adds custom inline styles to active breadcrumbs item. |
| separatorClassName | String | '' | Adds custom class to breadcrumbs separator.|
| separatorStyle | Object | {} | Adds custom inline styles to breadcrumbs separator. |
| separator | ReactElement | null | Adds custom breadcrumbs separator element. |
| transparentBackground | boolean | false | sets no background to breadcrumbs container. |
| customBackgroundClassName | String | '' | Adds custom class to custom breadcrumbs container.|
| customBackgroundStyle | Object | {} | Adds custom inline styles to custom breadcrumbs container. |
| customBackground | ReactElement | null | Adds custom breadcrumbs container element. |
| currentStep | string | null | sets current active breadcrumb link. |
| steps | {label: string; uri: string;} | [] | sets breadcrumb links list. |


## Contribute

1. [Submit an issue](https://github.com/gordienkotolik/material-ui-breadcrumbs/issues)
2. Fork the repository
3. Create a dedicated branch (never ever work in `master`)
4. The first time, run command: `yarn` into the directory
5. Fix bugs or implement features


## Future
- Add tests
- Add examples


## License
This project is licensed under the terms of the
[MIT license](https://github.com/gordienkotolik/material-ui-breadcrumbs/blob/master/LICENSE)

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