This module enhances the JSON:API output for Pathauto-generated paths by including a breadcrumb trail. The breadcrumbs, composed of path and label pairs, will be added to the path information in JSON:API resources, providing a hierarchical navigation structure.
Features
This module adds a list of breadcrumbs to the Path in the JSON:API resources like the following example
{
path: {
...
alias: "/projects/project-1",
breadcrumbs: [
{
path: "/",
label: "Home"
},
{
path: "/projects",
label: "Projects"
},
{
path: "/projects/project-1",
label: "Project 1"
}
]
}
}
Post-Installation
Navigate to /admin/config/services/jsonapi/resource_types and override a resource. Pathauto provides a Path field on which this applies. On the advanced operation you can select the Breadcrumbs Field enhancer.
Ask your assistant about JSON:API Pathauto Breadcrumbs
Check compatibility with your Drupal and PHP version, maintenance and security coverage, from current release data. How it works
Depends on
Dependencies of the latest stable release
- jsonapi Drupal core
- jsonapi_extras Drupal core
- pathauto Drupal core
Required by
Tracked projects that depend on this one
No tracked projects depend on this one yet.
Activity
Release Timeline
Releases
| Version | Type | Core | PHP | Release date | |
|---|---|---|---|---|---|
| 1.1.1 | Stable | 10–11 | PHP >=8.2 | Sep 23, 2026 | |
| 1.1.0 | Stable | 10–11 | PHP >=8.2 | May 29, 2024 | |
| 1.1.x-dev | Dev | 10–11 | PHP >=8.2 | May 29, 2024 | |
| 1.0.2 | Stable | 10 | PHP >=8.2 | May 17, 2024 | |
| 1.0.1 | Stable | 10 | PHP >=8.2 | Apr 8, 2024 | |
| 1.0.0 | Stable | 10 | PHP >=8.2 | Mar 17, 2024 | |
| 1.0.x-dev | Dev | 10 | PHP >=8.2 | Mar 17, 2024 |