use-react-router-breadcrumbs

• Fixes a type mismatch with the latest version of react-router-dom (#71)

• Migrates from a peer dependency on react-router to react-router-dom instead. (Fixes #59)

The original reason for requiring react-router is because it is compatible with both web and react-native, so this hook now (as of version 4.0.0) only supports web. If there is enough interest, we can spin up another hook specifically for react-native.

• Exports a new Route that extends react-router's for Typescript convenience when using dynamic routes. (#46) (thanks @MichaelDimmitt)

• Adds support for declarative (<Route \> component) routes #46 (thanks @MichaelDimmitt)

• Adjusts the automatic breadcrumbs generator to replace - with . For example, a URL with "some-route" would now render a default breadcrumb of "Some route" instead of "Some-route" #42 (thanks @codytooker)
• Adds an additional option defaultFormatter for users to provide their own function to generate default breadcrumbs (string) => string #42 (thanks @codytooker)

• feat: adds ability to add metadata to route object #39 (@arjandepooter)

• fix: Support layout routes (fixes #34)

• Support for react-router 6. #31 (huge thanks to @Grapedge for the refactor)

Note

Version >=3 only supports react-router 6... if you are still using react-router 5 please continue to use v2.0.2

• Fixes type definitions (#28)

• Maintenance release: updates all dev dependencies, node target, and bundle size improvements

• Adds a props option in route config for passing properties through to the breadcrumb components. Previously, we were passing through all additional props on the route object, by moving it to an explicit props option we can avoid property conflicts and have better types support.

This will not be a breaking change unless you are already including extra props in your route objects.

For example:

const routes = [{
  path: '/path',
  breadcrumb: ({ extraProp }) => <span>{extraProp}</span>,
  props: { extraProp: 'extra' },  // optional extra pass-through props for breadcrumb components
}]

useBreadcrumbs(routes)

• Fixes a typing issue with allowing null for breadcrumb (#12)

• Fixes typescript definitions (#7) (thanks @ksocha)

• Fix: edge case for multiple slashes in a URL (for example: site.com/sandwiches//tuna)

• Fixes typescript definitions (#3)

• Removes react-router-dom as a peer dependency