|
4 | 4 |
|
5 | 5 | <p align="center">
|
6 | 6 | <a href="https://github.com/icd2k3/use-react-router-breadcrumbs/actions" target="_blank"><img src="https://github.com/icd2k3/use-react-router-breadcrumbs/workflows/Node.js%20CI/badge.svg" /></a>
|
7 |
| - <a href="https://david-dm.org/icd2k3/use-react-router-breadcrumbs" title="dependencies status"><img src="https://david-dm.org/icd2k3/use-react-router-breadcrumbs/status.svg"/></a> |
8 | 7 | <a href='https://coveralls.io/github/icd2k3/use-react-router-breadcrumbs?branch=master'><img src='https://coveralls.io/repos/github/icd2k3/use-react-router-breadcrumbs/badge.svg?branch=master' alt='Coverage Status' /></a>
|
9 | 8 | </p>
|
10 | 9 |
|
11 | 10 | <p align="center">
|
12 |
| - A small (~1.25kb gzip), flexible, <a href="https://reactjs.org/docs/hooks-intro.html">hook</a> for rendering breadcrumbs with <a href="https://github.com/ReactTraining/react-router">react-router</a> (5.1 and up). |
| 11 | + A small (~1.25kb gzip), flexible, <a href="https://reactjs.org/docs/hooks-intro.html">hook</a> for rendering breadcrumbs with <a href="https://github.com/ReactTraining/react-router">react-router 6</a>. |
13 | 12 | </p>
|
14 | 13 |
|
15 | 14 | <hr/>
|
|
21 | 20 | <hr/>
|
22 | 21 |
|
23 | 22 | <p align="center">
|
24 |
| - <code> |
25 |
| - If you'd rather use a Higher Order Component, check out <a href="https://github.com/icd2k3/react-router-breadcrumbs-hoc">react-router-breadcrumbs-hoc</a> |
26 |
| - </code> |
| 23 | + Using an <b>older version</B> of <code>react-router</code>? Check out <a href="https://github.com/icd2k3/react-router-breadcrumbs-hoc">react-router-breadcrumbs-hoc</a> which is compatible with v4 and v5. |
27 | 24 | </p>
|
28 | 25 |
|
| 26 | +--- |
| 27 | + |
29 | 28 | <!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
30 | 29 | <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
31 | 30 | - [Description](#description)
|
|
46 | 45 |
|
47 | 46 | ## Description
|
48 | 47 |
|
49 |
| -Render breadcrumbs for `react-router` however you want! |
| 48 | +Render breadcrumbs for `react-router` 6 however you want! |
50 | 49 |
|
51 | 50 | #### Features
|
52 | 51 | - Easy to get started with automatically generated breadcrumbs.
|
@@ -260,9 +259,7 @@ useBreadcrumbs(routes, { excludePaths: ['/', '/no-breadcrumb/for-this-route'] })
|
260 | 259 |
|
261 | 260 | ## Order matters!
|
262 | 261 |
|
263 |
| -`use-react-router-breadcrumbs` uses the same strategy as `React Router v6` to calculate the routing order. |
264 |
| - |
265 |
| -... in certain cases. Consider the following: |
| 262 | +`use-react-router-breadcrumbs` uses the [same strategy](https://reactrouter.com/docs/en/v6/getting-started/concepts#ranking-routes) as `react-router 6` to calculate the routing order. |
266 | 263 |
|
267 | 264 | ```js
|
268 | 265 | [
|
|
0 commit comments