@@ -163,14 +163,16 @@ ___
163
163
164
164
## ` Breadcrumbs` component props
165
165
166
- * ` separator` - separator between breadcrumbs items (default: undefined)
167
- * ` item` - component of breadcrumbs items (default: 'a')
168
- * ` finalItem` - component of final breadcrumbs item (default: value of ` item` prop)
169
- * ` finalProps` - final item props which override specified in ` BreadcrumbsItem` (default: {})
170
- * ` container` - wrapper component (default is ` span` )
171
- * ` containerProps` - props for ` container` components if defined (default: {})
172
- * ` renameProps` - rename props passed from item intermedator to item
173
- * ` duplicateProps` - duplicate same as ` renameProps` but without remove original.
166
+ | property | type | default | description |
167
+ | -------- | ---- | ------- | ------- |
168
+ | ` separator` | *element* | ` undefined ` | separator between breadcrumbs items |
169
+ | ` item` | *component* | ` a` | component of breadcrumbs items |
170
+ | ` finalItem` | *component* | value of ` item` prop | component of final breadcrumbs item |
171
+ | ` finalProps` | *object* | ` {}` | final item props - will override specified in ` BreadcrumbsItem` |
172
+ | ` container` | *component* | ` span` | wrapper component |
173
+ | ` containerProps` | *object* | ` {}` | props for ` container` component |
174
+ | ` renameProps` | *object* | ` {}` | rename props passed from item ` BreadcrumbsItem` to ` item` |
175
+ | ` duplicateProps` | *object* | ` {}` | duplicate props passed from item ` BreadcrumbsItem` to ` item` |
174
176
175
177
176
178
## ` BreadcrumbsItem` component props
@@ -179,21 +181,24 @@ The `BreadcrumbsItem` component may have any prop and may have children. Each pr
179
181
for ` BreadcrumbsItem` will be passed to correspondent breadcrumb component specified
180
182
in ` item` or ` finalItem` prop of ` Breadcrumbs` . Only one prop is mandatory.
181
183
182
- * ` to` - mandatory required bearing key with URL for breadcrumbs working
183
- * ` ... ` - any more number of properties.
184
+ | property | type | default | description |
185
+ | -------- | ---- | ------- | ------- |
186
+ | ` to` | *string* | required | mandatory required bearing key with URL |
187
+ | ` ... ` | *any* | | any properties - will be mapped to correspondent breadcrumb item |
184
188
189
+ ___
185
190
186
- ## ` withBreadcrumbsItem ()` function
191
+ ### ` withBreadcrumbsItem ()` function
187
192
188
- This function creates higher order component. It acquire one argument with your
189
- custom react component and return appropriate component which will have
190
- ` breadcrumbs` in its props with methods ` item ()` and ` items ()`
191
- like ` throughAgent` from [react-through](https://github.com/oklas/react-through).
193
+ Advanced usage higher order component function . It acquire one argument with
194
+ your custom react component and return appropriate component which will have
195
+ ` breadcrumbs` in its props with methods ` item ()` and ` items ()` like
196
+ ` throughAgent` from [react-through](https://github.com/oklas/react-through).
192
197
193
198
194
199
### ` this .props .breadcrumbs .item ()` and ` this .props .breadcrumbs .items ()`
195
200
196
- Methods to configure breadcrumbs item of your current react component.
201
+ Advanced usage methods to configure breadcrumbs item of your react component.
197
202
These methods will be added to props by HOC of ` withBreadcrumbsItem` function.
198
203
The function ` item ()` accepts one react component with props and the functions
199
204
` items ()` accepts react component with children which may contain any number of
@@ -213,8 +218,10 @@ The prop name which contain bearing key is defined in
213
218
` breadcrumbsBearingKey` .
214
219
215
220
221
+ ` ` ` javascript
216
222
import { breadcrumbsThroughArea } from ' react-breadcrumbs-dynamic'
217
223
import { breadcrumbsBearingKey } from ' react-breadcrumbs-dynamic'
224
+ ` ` `
218
225
219
226
220
227
## LICENSE
0 commit comments