Meta Tags

Nuxt 3 provides several different ways to manage your meta tags.

Through your nuxt.config.
Through the useHead composable
Through global meta components

You can customize title, titleTemplate, base, script, noscript, style, meta, link, htmlAttrs and bodyAttrs.

::alert{icon=📦} Nuxt currently uses vueuse/head to manage your meta tags, but implementation details may change. ::

Migration

In your nuxt.config, rename head to meta. Consider moving this shared meta configuration into your app.vue instead. (Note that objects no longer have a hid key for deduplication.)
If you need to access the component state with head, you should migrate to using useHead . You might also consider using the built-in meta-components.
If you need to use the Options API, there is a head() method you can use when you use defineNuxtComponent.

Example: useHead

::code-group

<script>
export default {
  data: () => ({
    title: 'My App',
    description: 'My App Description'
  })
  head () {
    return {
      title: this.title,
      meta: [{
        hid: 'description',
        name: 'description',
        content: this.description
      }]
    }
  }
}
</script>

<script setup lang="ts">
const title = ref('My App')
const description = ref('My App Description')

// This will be reactive even you change title/description above
useHead({
  title,
  meta: [{
    name: 'description',
    content: description
  }]
})
</script>

Example: Built-in Meta-components

Nuxt 3 also provides meta components that you can use to accomplish the same task. While these components look similar to HTML tags, they are provided by Nuxt and have similar functionality.

::code-group

<script>
export default {
  head () {
    return {
      title: 'My App',
      meta: [{
        hid: 'description',
        name: 'description',
        content: 'My App Description'
      }]
    }
  }
}
</script>

<template>
  <div>
    <Head>
      <Title>My App</Title>
      <Meta name="description" content="My app description"/>
    </Head>
    <!-- -->
  </div>
</template>

::alert{icon=👉}

Make sure you use capital letters for these component names to distinguish them from native HTML elements (<Title> rather than <title>).
You can place these components anywhere in your template for your page. ::

Example: Options API

<script>
// if using options API `head` method you must use `defineNuxtComponent`
export default defineNuxtComponent({
  head (nuxtApp) {
    // `head` receives the nuxt app but cannot access the component instance
    return {
      meta: [{
        name: 'description',
        content: 'This is my page description.'
      }]
    }
  }
})
</script>

3.0 KiB Raw Permalink Blame History

Meta Tags

Migration

Example: useHead

Example: Built-in Meta-components

Example: Options API

3.0 KiB

Raw Permalink Blame History