Schema
Breadcrumb
Schema.org Breadcrumb
- Type:
defineBreadcrumb(input?: Breadcrumb)
Describes anBreadcrumbon aWebPage. - Component:
SchemaOrgBreadcrumb(see how components work)
Useful Links
- BreadcrumbList - Schema.org
- Breadcrumb Schema Markup - Google Search Central
- Breadcrumb - Yoast
- Recipe: Breadcrumbs
Required properties
- itemListElement
An array ofListItemobjects, representing the position of the current page in the site hierarchy.
Examples
Minimal
defineBreadcrumb({
itemListElement: [
{ name: 'Home', item: '/' },
{ name: 'Blog', item: '/blog' },
{ name: 'My Article' },
],
})
Defaults
- @type:
BreadcrumbList - @id:
${canonicalUrl}#breadcrumb
Relation Transforms
- sets default
breadcrumbto this node
Resolves
itemListElement.positionis computed for each list element
Types
/**
* A BreadcrumbList is an ItemList consisting of a chain of linked Web pages,
* typically described using at least their URL and their name, and typically ending with the current page.
*/
export interface BreadcrumbSimple extends ItemList {}