` with any props and children.\n\nExample tree of routed components with breadcrumbs items:\n\n``` javascript\nimport {BreadcrumbsItem} from 'react-breadcrumbs-dynamic'\n\nconst App = (props) => (\n \n Main Page\n {props.children}\n \n
\n)\n\nconst User = (props) => (\n \n Home\n
Home
\n {props.children}\n \n \n)\n\nconst Contacts = (props) => (\n \n Contacts\n
Contacts
\n ...\n \n)\n```\n\nYou can declaratively pass props with any data, functions, components and so on\nthrough react tree in any direction because\n[react-through](https://github.com/oklas/react-through#readme) allows to do that.\n\n\n# Result\n\nThe result of above code will represent breadcrumbs like this:\n\n``` javascript\n Main Page\n / \n Home\n / \n Contacts\n```\n\nIf you use library or if you think that it is good for use -\nlet people know about that - click the star.\n\n___\n\n\n# The components and functions\n\n## `Breadcrumbs` component props\n\nThe breadcrumbs instance is implemented in the `Breadcrumbs` component, which\nis the `through container` in terms of\n[react-through](https://github.com/oklas/react-through#readme).\n\n| property | type | default | description |\n| -------- | ---- | ------- | ------- |\n| `separator` | *element* | `undefined` | separator between breadcrumbs items |\n| `item` | *component* | `a` | component of breadcrumbs items |\n| `finalItem` | *component* | value of `item` prop | component of final breadcrumbs item |\n| `finalProps` | *object* | `{}` | final item props - will override specified in `BreadcrumbsItem` |\n| `container` | *component* | `span` | wrapper component |\n| `containerProps` | *object* | `{}` | props for `container` component |\n| `compare` | *function* | (a,b)=>a.to.length-b.to.length | comparision function for sorting items |\n| `hideIfEmpty` | *boolean* | `false` | show or hide breadcrumbs container if items exist or not |\n| `renameProps` | *object* | `{}` | rename props passed from item `BreadcrumbsItem` to `item` |\n| `duplicateProps` | *object* | `{}` | duplicate props passed from item `BreadcrumbsItem` to `item` |\n| `removeProps` | *object* | `{}` | props aren't passed from item `BreadcrumbsItem` to `item` |\n\n\n## `BreadcrumbsItem` component props\n\nThe `BreadcrumbsItem` component is the `through agent` with bearing key in\nprop `to` in terms of [react-through](https://github.com/oklas/react-through#readme).\n\nThe `BreadcrumbsItem` component may have any prop and may have children. Each prop\nfor `BreadcrumbsItem` will be passed to correspondent breadcrumb component specified\nin `item` or `finalItem` prop of `Breadcrumbs`. Only one prop is mandatory.\n\n| property | type | default | description |\n| -------- | ---- | ------- | ------- |\n| `to` | *string* | required | mandatory required bearing key with URL |\n| `...` | *any* | | any properties - will be mapped to correspondent breadcrumb item |\n\n___\n\n\n### `withBreadcrumbsItem()` function\n\nAdvanced usage higher order component function. It acquire one argument with\nyour custom react component and return appropriate component which will have\n`breadcrumbs` in its props with methods `item()` and `items()` like\n`throughAgent` from [react-through](https://github.com/oklas/react-through#readme).\n\n\n### `this.props.breadcrumbs.item()` and `this.props.breadcrumbs.items()`\n\nAdvanced usage methods to configure breadcrumbs item of your react component.\nThese methods will be added to props by HOC of `withBreadcrumbsItem` function.\nThe function `item()` accepts one react component with props and the functions\n`items()` accepts react component with children which may contain any number of\ncomponents to create correspondent number of breadcrumbs item. The breadcrumbs\nitem for these functions may be any react component and only props is\nsignificant. The `Dummy` and the `Item` components is exported by library\nfor this case. Each function accepts null to reset breadcrumbs items to none if\ncurrent component is no more needed to represent any breadcrumbs items.\n\n\n### constants\n\nThe `through area` name used by this library is defined in\n`breadcrumbsThroughArea` variable.\n\nThe prop name which contain bearing key is defined in\n`breadcrumbsBearingKey`.\n\n\n``` javascript\nimport { breadcrumbsThroughArea } from 'react-breadcrumbs-dynamic'\nimport { breadcrumbsBearingKey } from 'react-breadcrumbs-dynamic'\n```\n\n\n## LICENSE\n\n#### [MIT](./LICENSE.md)\n","readmeFilename":"README.md"}