react-router-breadcrumbs-hoc

Breaking Change

withBreadcrumbs now returns an array of Objects instead of Components:

-  breadcrumbs.map(breadcrumb)
+  breadcrumbs.map({ breadcrumb })

Within this object, other props like match, location, and pass-through props are also returned:

-  breadcrumbs.map((breadcrumb) => {})
+  breadcrumbs.map(({ breadcrumb, match, location, someCustomProp }) => {})

You can read more about this change here

Other

• Maintains dependencies
• Updates docs to match the changes above

• (fix) fixes a console warning that can occur when using react-router config. https://github.com/icd2k3/react-router-breadcrumbs-hoc/issues/59
• (chore) upgrades some development dependencies

• Fix #48 Adds functionality to optionally pass through other props to each breadcrumb (thanks @taschetto)

• Updating dev dependencies. Functionality should be the same, but there were a couple major upgrades, so this version bump represents that.

• Improves TypeScript types. Fixes https://github.com/icd2k3/react-router-breadcrumbs-hoc/issues/42

• Fixes a duplicate key warning when using optional route params (see #37)

• Adds better TypeScript defs & tests (Thanks @9renpoto)
• Chore: adds compiled build tests
• Chore: keep dev dependencies up to date
• Chore: Switch from babel-preset-stage-1 to babel-preset-stage-3 (we weren't using any stage 1/2 features anyways)

• Added TypeScript support (fixes #32). Thanks @9renpoto!

• Keeps our dependencies up to date. No changes to end-functionality are anticipated.

• Adds an option to completely disable default breadcrumb generation disableDefaults (outlined in the readme)

• Adds support for nested routes in config (fixes https://github.com/icd2k3/react-router-breadcrumbs-hoc/issues/24)

This release includes a few key changes to the package. If you're migrating from v1.x.x please check out the migration guide. I don't anticipate any more core changes to the API, but please let me know in the issues tab if there is a problem with this current implementation.

• Sensible defaults: You no longer need to explicitly pass breadcrumb strings or components in. For example:
  /one/two --> Home / One / Two (with no route config passed).
• API change: when mapping over breadcrumbs. Instead of returning an array of objects like [{ breadcrumb, path, /* ... */ }] to the component using the HOC. We now just return a flat array of breadcrumb components with props included. This makes the rendering step a bit easier to read / use.
• There is a new options object with an optional excludePaths param to easily opt-out of generating breadcrumbs for certain paths
• withBreadcrumbs is now a default export

• Adds location object to each breadcrumb for more flexibility https://github.com/icd2k3/react-router-breadcrumbs-hoc/pull/23 thanks @mrchief. This is a breaking change only if you happen to be using the (not recommended, but supported) getBreadcrumbs exported function instead of the HOC itself.

• Support extending react-router route config with a breadcrumbs prop. Fixes https://github.com/icd2k3/react-router-breadcrumbs-hoc/issues/18 by no longer requiring breadcrumb to be present in route objects if it is not needed for that specific path.

• Fixes issue #13 by removing .mjs extension

• Added support for es6 module .mjs export. Thanks @mhelmer
• Dev dependency upgrades & cleanup

• Bug: Fixes an issue where some breadcrumb components can return Uncaught TypeError: Cannot call a class as a function

• Bump version to fix npm publish compiled build issue

• Add support for home "/" route matching: https://github.com/icd2k3/react-router-breadcrumbs-hoc/issues/3