---
title: "Breadcrumbs Module with Schema for Next.js"
description: "A breadcrumb navigation module with automatic schema.org structured data for improved search result trails."
---

# Breadcrumbs module

A trail of links leading to the current page, with BreadcrumbList schema.org microdata built in.

[View source on GitHub](https://github.com/nuotsu/sanitypress/tree/main/src/modules/breadcrumbs) (schema + React component)

## Module fields

| Field | Type | Description |
| --- | --- | --- |
| `crumbs` | array of `link` | Links leading up to the current page. The current page's title is added automatically at the end. |
| `structuredDataOnly` | boolean | Visually hides the trail but keeps it in the markup for search engines. Defaults to `false`. |
| `attributes` | `module-attributes` | Shared by every module: `uid` (HTML id for deep links), `hidden`, and `scopedCss`. |

## Demo: Breadcrumbs

Three crumbs, followed by this page's title.

Frequently Asked Questions

## Breadcrumbs module FAQ

### When should I use the Breadcrumbs module?

Use it on any page that sits below another page, such as docs, module pages, or blog posts, so visitors and search engines can see where the page lives in your site's hierarchy. It outputs BreadcrumbList schema.org markup, which Google can show as a breadcrumb trail in search results.

### How do I add the Breadcrumbs module to a page?

In Sanity Studio, open the page, click Add item in its Modules field, and pick Breadcrumbs. Fill in the fields, check it in the live Presentation preview, and publish. Modules can be reordered by dragging, and the same module can be used on any page as many times as you need.

### How do I customize the Breadcrumbs module?

Add the parent pages as crumbs; the current page's title is appended automatically. Turn on structuredDataOnly to hide the trail visually while keeping the breadcrumb markup in the HTML for search engines.

Every module also has a Scoped CSS field (plus a uid for deep links and a hidden toggle), so you can restyle one instance without touching the rest of the site. For bigger changes, edit the module's React component and schema in src/modules/breadcrumbs in the repo.

Previous module

![Tabbed content module](https://cdn.sanity.io/images/cyu7k2r0/production/f0474f7651cd1c51b96f4905c9c5075b242ded1e-1718x658.png)

[Tabbed content module](/modules/tabbed-content)

Next module

![Custom HTML module](https://cdn.sanity.io/images/cyu7k2r0/production/069a7d6293f1733d50ff0c21ad94b1f4e0c2f391-2560x458.png)

[Custom HTML module](/modules/custom-html)
