https://github.com/garmeeh/next-seo
Next SEO is a plug in that makes managing your SEO easier in Next.js projects.
https://github.com/garmeeh/next-seo
hacktoberfest hacktoberfest-accepted json-ld nextjs react seo typescript
Last synced: about 1 year ago
JSON representation
Next SEO is a plug in that makes managing your SEO easier in Next.js projects.
- Host: GitHub
- URL: https://github.com/garmeeh/next-seo
- Owner: garmeeh
- License: mit
- Created: 2018-06-12T21:19:56.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-04-16T21:02:31.000Z (about 1 year ago)
- Last Synced: 2025-05-07T23:39:16.339Z (about 1 year ago)
- Topics: hacktoberfest, hacktoberfest-accepted, json-ld, nextjs, react, seo, typescript
- Language: JavaScript
- Homepage:
- Size: 8.17 MB
- Stars: 7,920
- Watchers: 27
- Forks: 412
- Open Issues: 90
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- Awesome-NextJs - next-seo - `Next SEO is a plug in that makes managing your SEO easier in Next.js projects.` (Nextjs Plugins)
- awesome-nextjs - Next SEO - SEO made easy for Next.js (Extensions)
- awesome-indie-hacker-tools - Next SEO - LD结构化数据的管理。 (SEO / ORM)
- fucking-awesome-nextjs - Next SEO - SEO made easy for Next.js (Extensions)
- React-Toolkit - Next SEO
- awesome-nextjs - Next Seo - Next SEO is a plug in that makes managing your SEO easier in Next.js projects. (Tools)
- awesome-github-projects - next-seo - Next SEO is a plug in that makes managing your SEO easier in Next.js projects. ⭐8,463 `TypeScript` (🌐 Web Development - Frontend)
README
**SEObot — fully autonomous «SEO Robot» with AI agents**
SEObot takes 100% of SEO work out of your way so that you can focus on building your product. [Try it now](https://seobotai.com/?ref=next-seo)
[](https://seobotai.com/?ref=next-seo)
**Have you seen the new Next.js newsletter?**
[
](https://dub.sh/nextjsweekly)
**Useful Tools**
- [dub](https://dub.co/?utm_source=next-seo&utm_medium=social&utm_campaign=next-seo) recently launched a useful Free UTM builder! You can use it [here](https://dub.sh/iKTxs7b)
# Next SEO
Next SEO is a plugin that makes managing your SEO easier in Next.js projects.
Pull requests are very welcome. Also make sure to check out the issues for feature requests if you are
looking for inspiration on what to add.
**Feel like supporting this free plugin?**
It takes a lot of time to maintain an open source project so any small contribution is greatly appreciated.
Coffee fuels coding ☕️
[next-seo.wallet](https://unstoppabledomains.com/d/next-seo.wallet) (ERC20 & SOL)
**Note on app directory**
This note is only relevant if using the `app` directory.
For standard meta data (e.g., , ) then it is highly recommended that you use the built-in `generateMetaData` method. You can check out the docs [here](https://beta.nextjs.org/docs/guides/seo#usage)
For JSON-LD then, the only change needed is to add `useAppDir={true}` to the JSON-LD component in use. You should add use this component in your `page.js` and NOT your `head.js`.
```
```
If you are using **`pages`** directory then `NextSeo` is **exactly what you need** for your SEO needs!
### Table of Contents
- [Usage](#usage)
- [Setup](#setup)
- [Add SEO to Page](#add-seo-to-page)
- [Default SEO Configuration](#default-seo-configuration)
- [NextSeo Options](#nextseo-options)
- [Title Template](#title-template)
- [Default Title](#default-title)
- [No Index](#no-index)
- [dangerouslySetAllPagesToNoIndex](#dangerouslysetallpagestonoindex)
- [No Follow](#no-follow)
- [dangerouslySetAllPagesToNoFollow](#dangerouslysetallpagestonofollow)
- [robotsProps](#robotsprops)
- [Twitter](#twitter)
- [Facebook](#facebook)
- [Canonical URL](#canonical-url)
- [Alternate](#alternate)
- [Additional Meta Tags](#additional-meta-tags)
- [Additional Link Tags](#additional-link-tags)
- [Open Graph](#open-graph)
- [Open Graph Examples](#open-graph-examples)
- [Basic](#basic)
- [Video](#video)
- [Audio](#audio)
- [Article](#article)
- [Book](#book)
- [Profile](#profile)
- [JSON-LD](#json-ld)
- [JSON-LD Security](#json-ld-security)
- [Handling multiple instances](#handling-multiple-instances)
- [Article](#article-1)
- [Breadcrumb](#breadcrumb)
- [Blog](#blog)
- [Campground](#campground)
- [Recipe](#recipe)
- [Sitelinks Search Box](#sitelinks-search-box)
- [Course](#course)
- [Dataset](#dataset)
- [Corporate Contact](#corporate-contact)
- [FAQ Page](#faq-page)
- [How-to](#how-to)
- [Job Posting](#job-posting)
- [Local Business](#local-business)
- [Logo](#logo)
- [Product](#product)
- [Social Profile](#social-profile)
- [News Article](#news-article)
- [Park](#park)
- [Video](#video-1)
- [VideoGame](#videogame)
- [Event](#event)
- [Q&A](#qa)
- [Collection Page](#collection-page)
- [Profile page](#profile-page)
- [Carousel](#carousel)
- [Default (Summary List)](#default-summary-list)
- [Course](#course-1)
- [Movie](#movie)
- [Recipe](#recipe-1)
- [Custom](#custom)
- [Software App](#software-app)
- [Organization](#organization)
- [Brand](#brand)
- [WebPage](#webpage)
- [Image Metadata](#image-metadata)
- [Contributors](#contributors)
## Usage
`NextSeo` works by including it on pages where you would like SEO attributes to be added. Once included on the page, you pass it a configuration object with the page's SEO properties. This can be dynamically generated at a page level, or in some cases, your API may return an SEO object.
### Setup
First, install it:
```bash
npm install next-seo
```
or
```bash
yarn add next-seo
```
### Add SEO to Page
---
**Using Next.js app directory introduced in Next.js 13?**
If you are using the Next.js app directory, then it is highly recommended that you use the built-in `generateMetaData` method. You can check out the docs [here](https://beta.nextjs.org/docs/guides/seo#usage)
If you are using the `pages` directory, then `NextSeo` is exactly what you need for your SEO needs!
---
Then, you need to import `NextSeo` and add the desired properties. This will render out the tags in the `` for SEO. At a bare minimum, you should add a title and description.
**Example with just title and description:**
```jsx
import { NextSeo } from 'next-seo';
const Page = () => (
<>
Simple Usage
>
);
export default Page;
```
But `NextSeo` gives you many more options that you can add. See below for a typical example of a page.
**Typical page example:**
```jsx
import { NextSeo } from 'next-seo';
const Page = () => (
<>
SEO Added to Page
>
);
export default Page;
```
**A note on Twitter Tags**
Props `cardType`, `site`, `handle` are equivalent to `twitter:card`, `twitter:site`, `twitter:creator`. Documentation can be found [here](https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/summary).
Twitter will read the `og:title`, `og:image` and `og:description` tags for their card. `next-seo` omits `twitter:title`, `twitter:image` and `twitter:description` to avoid duplication.
Some tools may report this as an error. See [Issue #14](https://github.com/garmeeh/next-seo/issues/14)
### Default SEO Configuration
`NextSeo` enables you to set some default SEO properties that will appear on all pages without needing to include anything on them. You can also override these on a page-by-page basis if needed.
To achieve this, you will need to create a custom ``. In your pages directory, create a new file, `_app.js`. See the Next.js docs [here](https://nextjs.org/docs/advanced-features/custom-app) for more info on a custom ``.
Within this file you will need to import `DefaultSeo` from `next-seo` and pass it props.
Here is a typical example:
```jsx
import App, { Container } from 'next/app';
import { DefaultSeo } from 'next-seo';
// import your default seo configuration
import SEO from '../next-seo.config';
export default class MyApp extends App {
render() {
const { Component, pageProps } = this.props;
return (
);
}
}
```
To work properly, `DefaultSeo` should be placed above (before) `Component` due to the behavior of Next.js internals.
Alternatively, you can also create a config file to store default values such as `next-seo.config.js`
```js
export default {
openGraph: {
type: 'website',
locale: 'en_IE',
url: 'https://www.url.ie/',
siteName: 'SiteName',
},
twitter: {
handle: '@handle',
site: '@site',
cardType: 'summary_large_image',
},
};
```
or like this, if you are using TypeScript
```ts
import { DefaultSeoProps } from 'next-seo';
const config: DefaultSeoProps = {
openGraph: {
type: 'website',
locale: 'en_IE',
url: 'https://www.url.ie/',
siteName: 'SiteName',
},
twitter: {
handle: '@handle',
site: '@site',
cardType: 'summary_large_image',
},
};
export default config;
```
import at the top of `_app.js`
```jsx
import SEO from '../next-seo.config';
```
and the `DefaultSeo` component can be used like this instead
```jsx
```
From now on, all of your pages will have the defaults above applied.
**Note that `Container` is deprecated in Next.js v9.0.4 so you should replace that component here with `React.Fragment` on this version and later - see [here](https://github.com/zeit/next.js/blob/master/errors/app-container-deprecated.md)**
### NextSeo Options
| Property | Type | Description |
| ---------------------------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `titleTemplate` | string | Allows you to set default title template that will be added to your title [More Info](#title-template) |
| `title` | string | Set the meta title of the page |
| `defaultTitle` | string | If no title is set on a page, this string will be used instead of an empty `titleTemplate` [More Info](#default-title) |
| `noindex` | boolean (default false) | Sets whether page should be indexed or not [More Info](#no-index) |
| `nofollow` | boolean (default false) | Sets whether page should be followed or not [More Info](#no-follow) |
| `robotsProps` | Object | Set the more meta information for the `X-Robots-Tag` [More Info](#robotsprops) |
| `description` | string | Set the page meta description |
| `canonical` | string | Set the page canonical url |
| `mobileAlternate.media` | string | Set what screen size the mobile website should be served from |
| `mobileAlternate.href` | string | Set the mobile page alternate url |
| `languageAlternates` | array | Set the language of the alternate urls. Expects array of objects with the shape: `{ hrefLang: string, href: string }` |
| `themeColor` | string | Indicates a suggested color that user agents should use to customize the display of the page or of the surrounding user interface. Must contain a valid CSS color |
| `additionalMetaTags` | array | Allows you to add a meta tag that is not documented here. [More Info](#additional-meta-tags) |
| `additionalLinkTags` | array | Allows you to add a link tag that is not documented here. [More Info](#additional-link-tags) |
| `twitter.cardType` | string | The card type, which will be one of `summary`, `summary_large_image`, `app`, or `player` |
| `twitter.site` | string | @username for the website used in the card footer |
| `twitter.handle` | string | @username for the content creator / author (outputs as `twitter:creator`) |
| `facebook.appId` | string | Used for Facebook Insights, you must add a facebook app ID to your page to for it [More Info](#facebook) |
| `openGraph.url` | string | The canonical URL of your object that will be used as its permanent ID in the graph |
| `openGraph.type` | string | The type of your object. Depending on the type you specify, other properties may also be required [More Info](#open-graph) |
| `openGraph.title` | string | The open graph title, this can be different than your meta title. |
| `openGraph.description` | string | The open graph description, this can be different than your meta description. |
| `openGraph.images` | array | An array of images (object) to be used by social media platforms, slack etc as a preview. If multiple supplied you can choose one when sharing. [See Examples](#open-graph-examples) |
| `openGraph.videos` | array | An array of videos (object) |
| `openGraph.locale` | string | The locale the open graph tags are marked up in. Of the format language_TERRITORY. Default is en_US. |
| `openGraph.siteName` | string | If your object is part of a larger web site, the name which should be displayed for the overall site. |
| `openGraph.profile.firstName` | string | Person's first name. |
| `openGraph.profile.lastName` | string | Person's last name. |
| `openGraph.profile.username` | string | Person's username. |
| `openGraph.profile.gender` | string | Person's gender. |
| `openGraph.book.authors` | string[] | Writers of the article. [See Examples](#open-graph-examples) |
| `openGraph.book.isbn` | string | The [ISBN](https://en.wikipedia.org/wiki/International_Standard_Book_Number) |
| `openGraph.book.releaseDate` | datetime | The date the book was released. |
| `openGraph.book.tags` | string[] | Tag words associated with this book. |
| `openGraph.article.publishedTime` | datetime | When the article was first published. [See Examples](#open-graph-examples) |
| `openGraph.article.modifiedTime` | datetime | When the article was last changed. |
| `openGraph.article.expirationTime` | datetime | When the article is out of date after. |
| `openGraph.article.authors` | string[] | Writers of the article. |
| `openGraph.article.section` | string | A high-level section name. E.g. Technology |
| `openGraph.article.tags` | string[] | Tag words associated with this article. |
#### Title Template
Replaces `%s` with your title string
```js
title = 'This is my title';
titleTemplate = 'Next SEO | %s';
// outputs: Next SEO | This is my title
```
```js
title = 'This is my title';
titleTemplate = '%s | Next SEO';
// outputs: This is my title | Next SEO
```
#### Default Title
```js
title = undefined;
titleTemplate = 'Next SEO | %s';
defaultTitle = 'Next SEO';
// outputs: Next SEO
```
#### No Index
Setting this to `true` will set `noindex,follow` (to set `nofollow`, please refer to [`nofollow`](#no-follow)). This works on a page by page basis. This property works in tandem with the `nofollow` property and together they populate the `robots` meta tag.
**Note:** The `noindex` and the [`nofollow`](#no-follow) properties are a little different than all the others in the sense that setting them as a default does not work as expected. This is due to the fact Next SEO already has a default of `index,follow` because `next-seo` is a SEO plugin after all. So if you want to globally these properties, please see [dangerouslySetAllPagesToNoIndex](#dangerouslySetAllPagesToNoIndex) and [dangerouslySetAllPagesToNoFollow](#dangerouslySetAllPagesToNoFollow).
**Example No Index on a single page:**
If you have a single page that you want no indexed you can achieve this by:
```jsx
import { NextSeo } from 'next-seo';
const Page = () => (
<>
This page is no indexed
>
);
export default Page;
/*
*/
```
#### dangerouslySetAllPagesToNoIndex
It has the prefix `dangerously` because it will `noindex` all pages. As this is an SEO plugin, that is kinda dangerous action. It is **not** bad to use this. Just please be sure you want to `noindex` **EVERY** page. You can still override this at a page level if you have a use case to `index` a page. This can be done by setting `noindex: false`.
The only way to unset this is by removing the prop from the `DefaultSeo` in your custom ``.
#### No Follow
Setting this to `true` will set `index,nofollow` (to set `noindex`, please refer to [`noindex`](#no-index)). This works on a page-by-page basis. This property works in tandem with the `noindex` property, and together, they populate the `robots` meta tag.
**Note:** Unlike for the other properties, setting `noindex` and `nofollow` by default does not work as expected. This is because Next SEO has a default of `index,follow`, since `next-seo` is an SEO plugin after all. If you want to globally allow these properties, see [dangerouslySetAllPagesToNoIndex](#dangerouslySetAllPagesToNoIndex) and [dangerouslySetAllPagesToNoFollow](#dangerouslySetAllPagesToNoFollow).
**Example No Follow on a single page:**
If you have a single page that you want no indexed you can achieve this by:
```jsx
import { NextSeo } from 'next-seo';
const Page = () => (
<>
This page is not followed
>
);
export default Page;
/*
*/
```
#### dangerouslySetAllPagesToNoFollow
It has the prefix of `dangerously` because it will `nofollow` all pages. As this is an SEO plugin, that is kinda dangerous action. It is **not** bad to use this. Just please be sure you want to `nofollow` **EVERY** page. You can still override this at a page level if you have a use case to `follow` a page. This can be done by setting `nofollow: false`.
The only way to unset this, is by removing the prop from the `DefaultSeo` in your custom ``.
| `noindex` | `nofollow` | `meta` content of `robots` |
| --------- | ---------- | -------------------------- |
| -- | -- | `index,follow` (default) |
| false | false | `index,follow` |
| true | -- | `noindex,follow` |
| true | false | `noindex,follow` |
| -- | true | `index,nofollow` |
| false | true | `index,nofollow` |
| true | true | `noindex,nofollow` |
#### robotsProps
In addition to `index, follow` the `robots` meta tag accepts more properties to archive a more accurate crawling and serve better snippets for SEO bots that crawl your page.
Example:
```jsx
import { NextSeo } from 'next-seo';
const Page = () => (
<>
Additional robots props in Next-SEO!!
>
);
export default Page;
/*
*/
```
**Available properties**
| Property | Type | Description |
| ------------------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `noarchive` | boolean | Do not show a [cached link](https://support.google.com/websearch/answer/1687222) in search results. |
| `nosnippet` | boolean | Do not show a text snippet or video preview in the search results for this page. |
| `max-snippet` | number | Use a maximum of [number] characters as a textual snippet for this search result. [Read more](https://developers.google.com/search/reference/robots_meta_tag?hl=en-GB#directives) |
| `max-image-preview` | 'none','standard','large' | Set the maximum size of an image preview for this page in a search results. |
| `max-video-preview` | number | Use a maximum of [number] seconds as a video snippet for videos on this page in search results. [Read more](https://developers.google.com/search/reference/robots_meta_tag?hl=en-GB#directives) |
| `notranslate` | boolean | Do not offer translation of this page in search results. |
| `noimageindex` | boolean | Do not index images on this page. |
| `unavailable_after` | string | Do not show this page in search results after the specified date/time. The date/time must be specified in a widely adopted format including, but not limited to RFC 822, RFC 850, and ISO 8601. |
For more reference about the `X-Robots-Tag` visit [Google Search Central - Control Crawling and Indexing](https://developers.google.com/search/reference/robots_meta_tag?hl=en-GB#directives)
#### Twitter
Twitter will read the `og:title`, `og:image` and `og:description` tags for their card, this is why `next-seo` omits `twitter:title`, `twitter:image` and `twitter:description` so not to duplicate.
Some tools may report this as an error. See [Issue #14](https://github.com/garmeeh/next-seo/issues/14)
#### Facebook
```jsx
facebook={{
appId: '1234567890',
}}
```
Add this to your SEO config to include the fb:app_id meta if you need to enable Facebook insights for your site. Information regarding this can be found in Facebook's [documentation](https://developers.facebook.com/docs/sharing/webmasters/)
#### Canonical URL
Add this on a page-per-page basis when you want to consolidate duplicate URLs.
```js
canonical = 'https://www.canonical.ie/';
```
#### Alternate
This link relation is used to indicate a relation between a desktop and a mobile website to search engines.
Example:
```jsx
mobileAlternate={{
media: 'only screen and (max-width: 640px)',
href: 'https://m.canonical.ie',
}}
```
```jsx
languageAlternates={[{
hrefLang: 'de-AT',
href: 'https://www.canonical.ie/de',
}]}
```
#### Additional Meta Tags
This allows you to add any other meta tags that are not covered in the `config` and
should be used instead of `children` prop.
`content` is required. Then either `name`, `property` or `httpEquiv`. (Only one on each)
Example:
```js
additionalMetaTags={[{
property: 'dc:creator',
content: 'Jane Doe'
}, {
name: 'application-name',
content: 'NextSeo'
}, {
httpEquiv: 'x-ua-compatible',
content: 'IE=edge; chrome=1'
}]}
```
Invalid Examples:
These are invalid as they contain more than one of `name`, `property` and `httpEquiv` on the same entry.
```js
additionalMetaTags={[{
property: 'dc:creator',
name: 'dc:creator',
content: 'Jane Doe'
}, {
property: 'application-name',
httpEquiv: 'application-name',
content: 'NextSeo'
}]}
```
One thing to note on this is that it currently only supports unique tags unless you use the `keyOverride` prop to provide a unique [key](https://reactjs.org/docs/lists-and-keys.html#keys) to each additional meta tag.
The default behaviour (without a `keyOverride` prop) is to render one tag per unique `name` / `property` / `httpEquiv`. The last one defined will be rendered.
For example, if you pass 2 tags with the same `property`:
```js
additionalMetaTags={[{
property: 'dc:creator',
content: 'Joe Bloggs'
}, {
property: 'dc:creator',
content: 'Jane Doe'
}]}
```
it will result in this being rendered:
```html
```
Providing an additional `keyOverride` property like this:
```js
additionalMetaTags={[{
property: 'dc:creator',
content: 'Joe Bloggs',
keyOverride: 'creator1',
}, {
property: 'dc:creator',
content: 'Jane Doe',
keyOverride: 'creator2',
}]}
```
results in the correct HTML being rendered:
```html
```
#### Additional Link Tags
This allows you to add any other link tags that are not covered in the `config`.
`rel` and `href` is required.
Example:
```js
additionalLinkTags={[
{
rel: 'icon',
href: 'https://www.test.ie/favicon.ico',
},
{
rel: 'apple-touch-icon',
href: 'https://www.test.ie/touch-icon-ipad.jpg',
sizes: '76x76'
},
{
rel: 'manifest',
href: '/manifest.json'
},
{
rel: 'preload',
href: 'https://www.test.ie/font/sample-font.woof2',
as: 'font',
type: 'font/woff2',
crossOrigin: 'anonymous'
}
]}
```
it will result in this being rendered:
```html
```
## Open Graph
For the full specification please check out
Next SEO currently supports:
- [basic](#basic)
- [video](#video)
- [article](#article)
- [book](#book)
- [profile](#profile)
### Open Graph Examples
#### Basic
```jsx
import { NextSeo } from 'next-seo';
const Page = () => (
<>
Basic
>
);
export default Page;
```
**Note**
Multiple images are available from next.js version `7.0.0-canary.0`
For versions `6.0.0` - `7.0.0-canary.0` you just need to supply a single item array:
```js
images: [
{
url: 'https://www.example.ie/og-image-01.jpg',
width: 800,
height: 600,
alt: 'Og Image Alt',
},
],
```
Supplying multiple images will not break anything, but only one will be added to the head.
#### Video
Full info on [http://ogp.me/](http://ogp.me/#type_video)
```jsx
import { NextSeo } from 'next-seo';
const Page = () => (
<>
Video Page SEO
>
);
export default Page;
```
**Note**
Multiple images are available from next.js version `7.0.0-canary.0`
For versions `6.0.0` - `7.0.0-canary.0` you just need to supply a single item array:
```js
images: [
{
url: 'https://www.example.ie/og-image-01.jpg',
width: 800,
height: 600,
alt: 'Og Image Alt',
},
],
```
Supplying multiple images will not break anything, but only one will be added to the head.
#### Audio
Full info on [http://ogp.me/](https://ogp.me/#structured)
```jsx
import { NextSeo } from 'next-seo';
const Page = () => (
<>
Audio Page SEO
>
);
export default Page;
```
#### Article
```jsx
import { NextSeo } from 'next-seo';
const Page = () => (
<>
Article
>
);
export default Page;
```
**Note**
Multiple images, authors, and tags are available from next.js version `7.0.0-canary.0`
For versions `6.0.0` - `7.0.0-canary.0` you just need to supply a single item array:
`images:`
```js
images: [
{
url: 'https://www.example.ie/og-image-01.jpg',
width: 800,
height: 600,
alt: 'Og Image Alt',
},
],
```
`authors:`
```js
authors: [
'https://www.example.com/authors/@firstnameA-lastnameA',
],
```
`tags:`
```js
tags: ['Tag A'],
```
Supplying multiple of any of the above will not break anything, but only one will be added to the head.
#### Book
```jsx
import { NextSeo } from 'next-seo';
const Page = () => (
<>
Book
>
);
export default Page;
```
**Note**
Multiple images, authors, and tags are available from next.js version `7.0.0-canary.0`
For versions `6.0.0` - `7.0.0-canary.0` you just need to supply a single item array:
`images:`
```js
images: [
{
url: 'https://www.example.ie/og-image-01.jpg',
width: 800,
height: 600,
alt: 'Og Image Alt',
},
],
```
`authors:`
```js
authors: [
'https://www.example.com/authors/@firstnameA-lastnameA',
],
```
`tags:`
```js
tags: ['Tag A'],
```
Supplying multiple of any of the above will not break anything, but only one will be added to the head.
#### Profile
```jsx
import { NextSeo } from 'next-seo';
const Page = () => (
<>
Profile
>
);
export default Page;
```
**Note**
Multiple images are available from next.js version `7.0.0-canary.0`
For versions `6.0.0` - `7.0.0-canary.0` you just need to supply a single item array:
```js
images: [
{
url: 'https://www.example.ie/og-image-01.jpg',
width: 800,
height: 600,
alt: 'Og Image Alt',
},
],
```
Supplying multiple images will not break anything, but only one will be added to the head.
## JSON-LD
Next SEO now has the ability to set JSON-LD a form of structured data. Structured data is a standardized format for providing information about a page and classifying the page content.
Google has excellent content on JSON-LD -> [HERE](https://developers.google.com/search/docs/data-types/article)
**If using the app directory then please ensure to add `useAppDir={true}` prop and that you are using the component in the `page.js`**
Below you will find a very basic page implementing each of the available JSON-LD types:
- [Article](#article-1)
- [Breadcrumb](#breadcrumb)
- [Blog](#blog)
- [Campground](#campground)
- [Recipe](#recipe)
- [Sitelinks Search Box](#sitelinks-search-box)
- [Course](#course)
- [Dataset](#dataset)
- [Corporate Contact](#corporate-contact)
- [FAQ Page](#faq-page)
- [How-to](#how-to)
- [Job Posting](#job-posting)
- [Local Business](#local-business)
- [Product](#product)
- [Social Profile](#social-profile)
- [News Article](#news-article)
- [Park](#park)
Pull requests are very welcome to add any from the list [found here](https://developers.google.com/search/docs/data-types/article)
#### JSON-LD Security
Just a quick note on security. To get JSON-LD onto the page it needs to be in a script tag. `next-seo` achieves this by using a script tag with `dangerouslySetInnerHTML`.
So if passing anything directly from a URL to one of the components below please ensure you sanitize it first if needed.
View `toJson.tsx` for implementation detail.
#### Handling multiple instances
If your page requires multiple instances of a given JSON-LD component, you can specify unique `keyOverride` properties, and `next-seo` will handle the rest.
This comes in handy for blog rolls, search results, and overview pages.
Please fully research when you should and shouldn't add multiple instances of JSON-LD.
```jsx
```
### Article
```jsx
import { ArticleJsonLd } from 'next-seo';
const Page = () => (
<>
Article JSON-LD
>
);
export default Page;
```
### Breadcrumb
```jsx
import { BreadcrumbJsonLd } from 'next-seo';
const Page = () => (
<>
Breadcrumb JSON-LD
>
);
export default Page;
```
**Required properties**
| Property | Info |
| --------------------------- | -------------------------------------------------------------------------------------------------------- |
| `itemListElements` | |
| `itemListElements.position` | The position of the breadcrumb in the breadcrumb trail. Position 1 signifies the beginning of the trail. |
| `itemListElements.name` | The title of the breadcrumb displayed for the user. |
| `itemListElements.item` | The URL to the webpage that represents the breadcrumb. |
**Other**
| `useAppDir` | This should be set to true if using the new app directory. Not required if outside of the app directory. |
### Blog
```jsx
import { ArticleJsonLd } from 'next-seo';
const Page = () => (
<>
Blog JSON-LD
>
);
export default Page;
```
### Campground
```jsx
import { CampgroundJsonLd } from 'next-seo';
const Page = () => (
<>
Campground JSON-LD
>
);
export default Page;
```
**Required properties**
| Property | Info |
| ------------------------- | ------------------------------------------------------------------- |
| `@id` | Globally unique ID of the specific campground in the form of a URL. |
| `address` | Address of the specific campground location |
| `address.addressCountry` | The 2-letter ISO 3166-1 alpha-2 country code |
| `address.addressLocality` | City |
| `address.addressRegion` | State or province, if applicable. |
| `address.postalCode` | Postal or zip code. |
| `address.streetAddress` | Street number, street name, and unit number. |
| `name` | Campground name. |
| `description` | Campground description. |
**Supported properties**
| Property | Info |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `geo` | Geographic coordinates of the campground. |
| `geo.latitude` | The latitude of the campground location |
| `geo.longitude` | The longitude of the campground location |
| `images` | An image or images of the campground. Required for valid markup depending on the type |
| `telephone` | A campground phone number meant to be the primary contact method for customers. |
| `url` | The fully-qualified URL of the specific campground. |
| `openingHours` | Opening hour specification of the campground. You can provide this as a single object, or an array of objects with the properties below. |
| `openingHours.opens` | The opening hour of the place or service on the given day(s) of the week. |
| `openingHours.closes` | The closing hour of the place or service on the given day(s) of the week. |
| `openingHours.dayOfWeek` | The day of the week for which these opening hours are valid. Can be a string or array of strings. Refer to [DayOfWeek](https://schema.org/DayOfWeek) |
| `openingHours.validFrom` | The date when the item becomes valid. |
| `openingHours.validThrough` | The date after when the item is not valid. |
| `isAccessibleForFree` | Whether or not the campground is accessible for free. |
| `petsAllowed` | Whether or not the campgroud allows pets. |
| `amenityFeature` | An amenity feature (e.g. a characteristic or service) of the campground. |
| `amenityFeature.name` | The name of the amenity. |
| `amenityFeature.value` | The value of the amenity. |
| `priceRange` | The price range of the campground, for example $$$. |
| `rating` | The average rating of the campground based on multiple ratings or reviews. |
| `rating.ratingValue` | The rating for the content. |
| `rating.ratingCount` | The count of total number of ratings. |
**Other**
| `useAppDir` | This should be set to true if using the new app directory. Not required if outside of the app directory. |
### Recipe
```jsx
import { RecipeJsonLd } from 'next-seo';
const Page = () => (
<>
Recipe JSON-LD
>
);
export default Page;
```
**Required properties**
| Property | Info |
| ------------------- | ------------------------------------------------------------------- |
| `name` | The name of the recipe |
| `description` | A description of the recipe |
| `authorName` | The name of the recipe author. Can be a string or array of strings. |
| `ingredients` | A list of ingredient strings |
| `instructions` | - |
| `instructions.name` | The name of the instruction step. |
| `instructions.text` | The directions of the instruction step. |
**Other**
| `useAppDir` | This should be set to true if using the new app directory. Not required if outside of the app directory. |
### Sitelinks Search Box
```jsx
import { SiteLinksSearchBoxJsonLd } from 'next-seo';
const Page = () => (
<>
Sitelinks Search Box JSON-LD
>
);
export default Page;
```
**Required properties**
| Property | Info |
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url` | URL of the website associated with the sitelinks searchbox |
| `potentialActions` | Array of one or two SearchAction objects. Describes the URI to send the query to, and the syntax of the request that is sent |
| `potentialActions.target` | For websites, the URL of the handler that should receive and handle the search query; for apps, the URI of the intent handler for your search engine that should handle queries |
| `potentialActions.queryInput` | Placeholder used in target, gets substituted for user given query |
**Other**
| `useAppDir` | This should be set to true if using the new app directory. Not required if outside of the app directory. |
Read the [documentation](https://developers.google.com/search/docs/appearance/structured-data/sitelinks-searchbox)
### Course
```jsx
import { CourseJsonLd } from 'next-seo';
const Page = () => (
<>
Course JSON-LD
>
);
export default Page;
```
**Required properties**
| Property | Info |
| --------------- | ------------------------------------------------------------ |
| `courseName` | The title of the course. |
| `description` | A description of the course. Display limit of 60 characters. |
| `provider.name` | The course provider name. |
| `provider.url` | The course provider name url. |
**Recommended properties**
| Property | Info |
| ------------- | ------------------------------- |
| `providerUrl` | The url to the course provider. |
**Other**
| `useAppDir` | This should be set to true if using the new app directory. Not required if outside of the app directory. |
### Dataset
```jsx
import { DatasetJsonLd } from 'next-seo';
const Page = () => (
<>
Dataset JSON-LD
>
);
export default Page;
```
**Required properties**
| Property | Info |
| ------------- | --------------------------------------------------------------------------------- |
| `description` | A short summary describing a dataset. Needs to be between 50 and 5000 characters. |
| `name` | A license under which the dataset is distributed. |
**Recommended properties**
| Property | Info |
| --------- | ------------------------------- |
| `license` | The url to the course provider. |
**Other**
| `useAppDir` | This should be set to true if using the new app directory. Not required if outside of the app directory. |
### Corporate Contact
```jsx
import { CorporateContactJsonLd } from 'next-seo';
const Page = () => (
<>
Corporate Contact JSON-LD
>
);
export default Page;
```
**Required properties**
| Property | Info |
| -------------------------- | ----------------------------------------------------------------------------------------------- |
| `url` | Url to the home page of the company's official site. |
| `contactPoint` | |
| `contactPoint.telephone` | An internationalized version of the phone number, starting with the "+" symbol and country code |
| `contactPoint.contactType` | Description of the purpose of the phone number i.e. `Technical Support`. |
**Recommended ContactPoint properties**
| Property | Info |
| -------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `contactPoint.areaServed` | `String` or `Array` of geographical regions served by the business. Example `"US"` or `["US", "CA", "MX"]` |
| `contactPoint.availableLanguage` | Details about the language spoken. Example `"English"` or `["English", "French"]` |
| `contactPoint.email` | Email asscosiated with the business` |
| `gecontactPointo.contactOption` | Details about the phone number. Example `"TollFree"` |
**Other**
| `useAppDir` | This should be set to true if using the new app directory. Not required if outside of the app directory. |
### FAQ Page
```jsx
import { FAQPageJsonLd } from 'next-seo';
const Page = () => (
<>
FAQ Page JSON-LD
>
);
export default Page;
```
**Required properties**
| Property | Info |
| ------------------------------- | ----------------------------------------------------------------------------- |
| `mainEntity` | |
| `mainEntity.questionName` | The full text of the question. For example, "How long is the delivery time?". |
| `mainEntity.acceptedAnswerText` | The full answer to the question. |
**Other**
| `useAppDir` | This should be set to true if using the new app directory. Not required if outside of the app directory. |
### How-to
```jsx
import { HowToJsonLd } from 'next-seo';
const Page = () => (
<>
How-to JSON-LD
>
);
export default Page;
```
**Required properties**
| Property | Info |
| -------- | ---------------------------------------------------------------------------------- |
| `name` | Name of the HowTo |
| `step` | An array of HowToStep elements which comprise the full instructions of the how-to. |
**Supported properties**
| Property | Info |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `estimatedCost` | The estimated cost of the supplies consumed when performing instructions. |
| `image` | Image of the completed how-to. |
| `supply` | A supply consumed when performing instructions or a direction. |
| `tool` | An object used (but not consumed) when performing instructions or a direction. |
| `totalTime` | The total time required to perform all instructions or directions (including time to prepare the supplies), in ISO 8601 duration format. |
**Other**
| `useAppDir` | This should be set to true if using the new app directory. Not required if outside of the app directory. |
### Job Posting
```jsx
import { JobPostingJsonLd } from 'next-seo';
const Page = () => (
<>
Job Posting JSON-LD
>
);
export default Page;
```
**Required properties**
| Property | Info |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `datePosted` | The original date that employer posted the job in ISO 8601 format |
| `description` | The full description of the job in HTML format |
| `hiringOrganization` | An object containing information about the company hiring with the following fields or the string `'confidential'` when hiring anonymously |
| `hiringOrganization.name` | Name of the company offering the job position |
| `hiringOrganization.sameAs` | URL of a reference Web page |
| `title` | The title of the job (not the title of the posting) |
| `validThrough` | The date when the job posting will expire in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601) |
**Supported properties**
| Property | Info |
| --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `applicantLocationRequirements` | The geographic location(s) in which employees may be located for to be eligible for the remote job |
| `baseSalary` | |
| `baseSalary.currency` | The currency in which the monetary amount is expressed |
| `baseSalary.value` | The value of the quantitative value. You can also provide an array of minimum and maximum salaries. . |
| `baseSalary.unitText` | A string indicating the unit of measurement [Base salary guideline](https://developers.google.com/search/docs/data-types/job-posting#basesalary) |
| `employmentType` | Type of employment [Employement type guideline](https://developers.google.com/search/docs/data-types/job-posting#basesalary) |
| `jobLocation` | The physical location(s) of the business where the employee will report to work (such as an office or worksite), not the location where the job was posted. |
| `jobLocation.streetAddress` | The street address. For example, 1600 Amphitheatre Pkwy |
| `jobLocation.addressLocality` | The locality. For example, Mountain View. |
| `jobLocation.addressRegion` | The region. For example, CA. |
| `jobLocation.postalCode` | The postal code. For example, 94043 |
| `jobLocation.addressCountry` | The country. For example, USA. You can also provide the two-letter ISO 3166-1 alpha-2 country code. |
| `jobLocationType` | A description of the job location [Job Location type guideline](https://developers.google.com/search/docs/data-types/job-posting#job-location-type) |
| `hiringOrganization.logo` | Logos on third-party job sites [Hiring Organization guideline](https://developers.google.com/search/docs/data-types/job-posting#hiring) |
| `experienceRequirements.occupational.minimumMonthsOfExperience` | The minimum number of months of experience that are required for the job posting. [Experience and Education Requirements](https://developers.google.com/search/docs/appearance/structured-data/job-posting#education-and-experience-properties-beta) |
| `experienceRequirements.educational.credentialCategory` | The level of education that's required for the job posting. Use one of the following: `high school`, `associate degree`, `bachelor degree`, `professional certificate`, `postgraduate degree` |
| `experienceRequirements.experienceInPlaceOfEducation` | Boolean: If set to true, this property indicates whether a job posting will accept experience in place of its formal educational qualifications. If set to true, you must include both the experienceRequirements and educationRequirements properties. |
**Other**
| `useAppDir` | This should be set to true if using the new app directory. Not required if outside of the app directory. |
### Local Business
Local business is supported with a sub-set of properties.
```jsx
```
**Required properties**
| Property | Info |
| ------------------------- | -------------------------------------------------------------------------- |
| `@id` | Globally unique ID of the specific business location in the form of a URL. |
| `type` | LocalBusiness or any sub-type |
| `address` | Address of the specific business location |
| `address.addressCountry` | The 2-letter ISO 3166-1 alpha-2 country code |
| `address.addressLocality` | City |
| `address.addressRegion` | State or province, if applicable. |
| `address.postalCode` | Postal or zip code. |
| `address.streetAddress` | Street number, street name, and unit number. |
| `name` | Business name. |
**Supported properties**
| Property | Info |
| --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `description` | Description of the business location |
| `geo` | Geographic coordinates of the business. |
| `geo.latitude` | The latitude of the business location |
| `geo.longitude` | The longitude of the business location |
| `rating` | The average rating of business based on multiple ratings or reviews. |
| `rating.ratingValue` | The rating for the content. |
| `rating.ratingCount` | The count of total number of ratings. |
| `priceRange` | The relative price range of the business. |
| `servesCuisine` | The type of cuisine the restaurant serves. |
| `images` | An image or images of the business. Required for valid markup depending on the type |
| `telephone` | A business phone number meant to be the primary contact method for customers. |
| `url` | The fully-qualified URL of the specific business location. |
| `sameAs` | An array of URLs that represent this business |
| `openingHours` | Opening hour specification of business. You can provide this as a single object, or an array of objects with the properties below. |
| `openingHours.opens` | The opening hour of the place or service on the given day(s) of the week. |
| `openingHours.closes` | The closing hour of the place or service on the given day(s) of the week. |
| `openingHours.dayOfWeek` | The day of the week for which these opening hours are valid. Can be a string or array of strings. Refer to [DayOfWeek](https://schema.org/DayOfWeek) |
| `openingHours.validFrom` | The date when the item becomes valid. |
| `openingHours.validThrough` | The date after when the item is not valid. |
| `review` | A review of the local business. |
| `review.author` | The author of this content or rating. |
| `review.reviewBody` | The actual body of the review. |
| `review.datePublished` | Date of first broadcast/publication. |
| `review.name` | The name of the item. |
| `review.rating` | The rating given in this review |
| `review.rating.ratingValue` | The rating for the content. |
| `review.rating.reviewAspect` | This Review or Rating is relevant to this part or facet of the itemReviewed. |
| `review.rating.worstRating` | The lowest value allowed in this rating system. If worstRating is omitted, 1 is assumed. |
| `review.rating.bestRating` | The highest value allowed in this rating system. If bestRating is omitted, 5 is assumed |
| `areasServed` | The geographic area where a service or offered item is provided. |
| `areasServed.GeoCircle` | A GeoCircle is a GeoShape representing a circular geographic area. |
| `areasServed.GeoCircle.geoMidpoint` | Indicates the GeoCoordinates at the centre of a GeoShape e.g. GeoCircle. |
| `areasServed.GeoCircle.geoMidpoint.latitude` | The latitude of a location. For example 37.42242 |
| `areasServed.GeoCircle.geoMidpoint.longitude` | The name of the item. |
| `areasServed.GeoCircle.geoRadius` | Indicates the approximate radius of a GeoCircle (metres unless indicated otherwise via Distance notation). |
| `makesOffer` | A pointer to products or services offered by the organization or person. |
| `makesOffer.offer` | An offer to transfer some rights to an item or to provide a service |
| `makesOffer.offer.priceSpecification` | One or more detailed price specifications, indicating the unit price and delivery or payment charges. |
| `makesOffer.offer.priceSpecification.priceCurrency` | The currency of the price, or a price component when attached to PriceSpecification and its subtypes. |
| `makesOffer.offer.priceSpecification.price` | The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes. |
| `makesOffer.offer.itemOffered` | An item being offered (or demanded) |
| `makesOffer.offer.itemOffered.name` | The name of the item |
| `makesOffer.offer.itemOffered.description` | The description of the item. |
| `action` | An action performed by a direct agent and indirect participants upon a direct object. |
| `action.target` | Indicates a target EntryPoint for an Action. |
**Other**
| `useAppDir` | This should be set to true if using the new app directory. Not required if outside of the app directory. |
**NOTE:**
Images are recommended for most of the types that you can use for `LocalBusiness`; if in doubt, you should add an image. You can check your generated JSON over at Google's [Structured Data Testing Tool](https://search.google.com/structured-data/testing-tool)
### Logo
```jsx
import { LogoJsonLd } from 'next-seo';
const Page = () => (
<>
Logo JSON-LD
>
);
export default Page;
```
| Property | Info |
| -------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `url` | The URL of the website associated with the logo. [Logo guidelines](https://developers.google.com/search/docs/data-types/logo#definitions) |
| `logo` | URL of a logo that is representative of the organization. |
**Other**
| `useAppDir` | This should be set to true if using the new app directory. Not required if outside of the app directory. |
### Product
```jsx
import { ProductJsonLd } from 'next-seo';
const Page = () => (
<>
Product JSON-LD
>
);
export default Page;
```
Also available: `sku`, `gtin8`, `gtin13`, `gtin14`.
Valid values for `offers.itemCondition`:
-
-
-
-
Valid values for `offers.availability`:
-
-
-
-
-
-
-
-
-
The property `aggregateOffer` is also available:
(It is ignored if `offers` is set)
**Required properties**
| Property | Info |
| --------------- | --------------------------------------------------------------------------------- |
| `lowPrice` | The lowest price of all offers available. Use a floating point number. |
| `priceCurrency` | The currency used to describe the product price, in three-letter ISO 4217 format. |
**Recommended properties**
| Property | Info |
| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `highPrice` | The highest price of all offers available. Use a floating point number. |
| `offerCount` | The number of offers for the product. |
| `offers` | An offer to transfer some rights to an item or to provide a service. You can provide this as a single object, or an array of objects with the properties below. |
**Other**
| `useAppDir` | This should be set to true if using the new app directory. Not required if outside of the app directory. |
More info on the product data type can be found [here](https://developers.google.com/search/docs/data-types/product).
### Social Profile
```jsx
import { SocialProfileJsonLd } from 'next-seo';
const Page = () => (
<>
Social Profile JSON-LD
>
);
export default Page;
```
**Required properties**
| Property | Info |
| -------- | ----------------------------------------------------------------------------------------- |
| `type` | Person or Organization |
| `name` | The name of the person or organization |
| `url` | The URL for the person's or organization's official website. |
| `sameAs` | An array of URLs for the person's or organization's official social media profile page(s) |
**Other**
| `useAppDir` | This should be set to true if using the new app directory. Not required if outside of the app directory. |
**Google Supported Social Profiles**
- Facebook
- Twitter
- Google+
- Instagram
- YouTube
- LinkedIn
- Myspace
- Pinterest
- SoundCloud
- Tumblr
### News Article
```jsx
import { NewsArticleJsonLd } from 'next-seo';
const Page = () => (
<>
News Article JSON-LD
>
);
export default Page;
```
### Park
```jsx
import { ParkJsonLd } from 'next-seo';
const Page = () => (
<>
Park JSON-LD