Schema.org Breadcrumb

  • Type: defineBreadcrumb(input?: Breadcrumb)
    Describes an Breadcrumb on a WebPage.
  • Component: SchemaOrgBreadcrumb (see how components work)

Required properties

  • itemListElement
    An array of ListItem objects, 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

WebPage

  • sets default breadcrumb to this node

Resolves

  • itemListElement.position is 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 {}
Table of Contents