/react-breadcrumb

Primary LanguageJavaScriptMIT LicenseMIT

React Breadcrumb Component

NPM version Build Status npm download

Breacrumb for use with React.

You can view an online example in https://amadormf.github.io/react-breadcrumb/

##Install

npm install --save react-breadcrumb

##Examples

import Breadcrumb from 'react-breadcrumb';
<Breadcrumb
  path={'/path/to/section'}
  separatorChar={' - '}
/>

Result: path - to - section

Manual paths

<Breadcrumb
  path={
    [
      {
        path: '/custom/path',
        label: 'path',
      },
      {
        path: '/custom/section',
        label: 'section',
      }
    ]
  }
>

##Props

Props Name Type Default Description
path [string or object] Path to draw
separatorChar string    / Separator of paths
onClick function Function that takes 2 parameters, event and path clicked
className String You can use a custom className
classes Object You can customize all classes of component