# `SEO.Breadcrumb`
[🔗](https://github.com/dbernheisel/phoenix_seo/blob/0.2.1/lib/seo/breadcrumb.ex#L1)

This is SEO for Google to display breadcrumbs in the search results.
This allows the search result to search as multiple links.

![Breadcrumb Example](./assets/breadcrumb-example.png)

### Resources

- https://developers.google.com/search/docs/data-types/breadcrumbs
- https://json-ld.org/
- https://search.google.com/test/rich-results
- https://search.google.com/structured-data/testing-tool

Rendered example inside a `<script type="application/ld+json">`:

```json
{
  "@context": "https://schema.org",
  "@type": "BreadcrumbList",
  "itemListElement": [{
    "@type": "ListItem",
    "item": "https://bernheisel.com/blog",
    "name": "Posts",
    "position": 1
  },{
    "@type": "ListItem",
    "item": "https://bernheisel.com/blog/nostalgia-programming",
    "name": "Nostalgia, Fun, and Programming",
    "position": 2
  }]
}
```

# `meta`

## Attributes

* `item` (`SEO.Breadcrumb.List`)
* `json_library` (`:atom`) (required)
* `config` (`:any`) - Defaults to `nil`.

---

*Consult [api-reference.md](api-reference.md) for complete listing*