UPGRADING.md

Upgrading

This document outlines breaking changes introduced in 0.x versions and major releases.

We accept PRs to improve this guide.

From 0.5.x to 0.6.0

Breadcrumbs without a route

null breadcrumb URLs are now supported for diglactic/laravel-breadcrumbs and tabuna/breadcrumbs collectors. Previously, defining a null URL would've thrown an exception, so this is technically a backwards-compatible change. However, because this changes the array shape of outputted breadcrumbs, you may want to update your frontend components to match. Here's an example TypeScript type to illustrate:

type Breadcrumb {
    title: string;
-   url: string;
+   url?: string;
    current?: boolean;
};

type Breadcrumbs = Breadcrumb[];

From 0.4.x to 0.5.x

Upgrading dependencies

This release adds support for Laravel 11. This package now also requires inertiajs/inertia-laravel: ^1.0.

Custom shared key

@squiaios added the ability to change the prop key used to share the breadcrumbs. By default these are shared using the breadcrumbs key. It's recommended to keep your config up-to-date with this change:

return [
    'middleware' => [
        // ...
+
+        /**
+         * The key of shared breadcrumbs
+         */
+        'key' => 'breadcrumbs',
    ],
];

From 0.3.x to 0.4.x

Query string is now ignored when determining the current URL (#9)

In version <0.3.x an active breadcrumb was determined by the full URL. This meant that a route such as /users/{id} would not set the active breadcrumb when a user visits /users/1?foo=bar. The default behaviour has been changed to ignore the query string.

The config file has been updated to disable this behaviour:

return [
    // ...

+    /**
+     * Whether the query string should be ignored when determining the current route
+     */
+    'ignore_query' => true,
];

If your app relies on the previous behaviour (not ignoring the query string) you can set the inertia-breadcrumbs.ignore_query config value to false.