Getting Started

Schema.org Params

Change the behaviour of your integration.

To configure multiple Schema.org nodes at once and reduce your boilerplate, you can leverage the schemaOrg option on templateParams.

useHead
useHead({
  templateParams: {
    schemaOrg: {
      host: 'https://example.com',
      path: '/blog'
    }
  }
})

Config

tagPosition

  • type: string
  • default: head
    The position of the Schema.org script tag. This is useful if you want to load the script in the body of your page.

host

  • type: string

The production URL of your site. This allows the client to generate all URLs for you and is important to set correctly.

path

  • type: string
  • default: window.location.pathname

The path of the current page. This allows the client to generate all URLs for you and is important to set correctly.

inLanguage

  • type: string
  • default: en

Will set the isLanguage to this value for any Schema which uses it. Should be a valid language code, i.e en-AU

trailingSlash

  • type: boolean
  • default: false

Whether to add a trailing slash to the URL. This is important for Google to understand the canonical URL of your page.