2022-10-06 09:15:30 +00:00
---
2022-10-12 17:00:17 +00:00
description: useHead customizes the head properties of individual pages of your Nuxt app.
2022-10-06 09:15:30 +00:00
---
2022-04-06 05:56:08 +00:00
# `useHead`
2022-11-15 16:26:38 +00:00
Nuxt provides the `useHead` composable to add and customize the head properties of individual pages of your Nuxt app.
2022-04-06 05:56:08 +00:00
2022-11-15 16:26:38 +00:00
`useHead` is powered by [@vueuse/head ](https://github.com/vueuse/head ), you can find more in-depth documentation [here ](https://unhead.harlanzw.com/ )
2022-04-11 21:00:43 +00:00
2022-11-16 10:04:28 +00:00
::ReadMore{link="/docs/getting-started/seo-meta"}
2022-10-12 17:00:17 +00:00
::
2022-09-03 10:57:21 +00:00
## Type
2022-04-11 21:00:43 +00:00
2022-09-03 10:57:21 +00:00
```ts
2022-10-12 17:00:17 +00:00
useHead(meta: MaybeComputedRef< MetaObject > ): void
```
2022-11-15 16:26:38 +00:00
Below are the non-reactive types for `useHead` . See [zhead ](https://github.com/harlan-zw/zhead/tree/main/packages/schema/src ) for more detailed types.
2022-10-12 17:00:17 +00:00
```ts
interface MetaObject {
2022-09-03 10:57:21 +00:00
title?: string
2022-10-12 17:00:17 +00:00
titleTemplate?: string | ((title?: string) => string)
base?: Base
link?: Link[]
meta?: Meta[]
style?: Style[]
script?: Script[]
noscript?: Noscript[]
htmlAttrs?: HtmlAttributes
bodyAttrs?: BodyAttributes
2022-09-03 10:57:21 +00:00
}
2022-04-11 21:00:43 +00:00
```
2022-09-03 10:57:21 +00:00
::alert{type=info}
The properties of `useHead` can be dynamic, accepting `ref` , `computed` and `reactive` properties. `meta` parameter can also accept a function returning an object to make the entire object reactive.
2022-04-06 05:56:08 +00:00
::
2022-04-11 21:00:43 +00:00
2022-09-03 10:57:21 +00:00
## Parameters
### `meta`
**Type**: `MetaObject`
An object accepting the following head metadata:
- `meta`
**Type** : `Array<Record<string, any>>`
Each element in the array is mapped to a newly-created `<meta>` tag, where object properties are mapped to the corresponding attributes.
- `link`
**Type** : `Array<Record<string, any>>`
Each element in the array is mapped to a newly-created `<link>` tag, where object properties are mapped to the corresponding attributes.
- `style`
**Type** : `Array<Record<string, any>>`
Each element in the array is mapped to a newly-created `<style>` tag, where object properties are mapped to the corresponding attributes.
- `script`
**Type** : `Array<Record<string, any>>`
Each element in the array is mapped to a newly-created `<script>` tag, where object properties are mapped to the corresponding attributes.
- `noscript`
**Type** : `Array<Record<string, any>>`
Each element in the array is mapped to a newly-created `<noscript>` tag, where object properties are mapped to the corresponding attributes.
- `titleTemplate`
**Type** : `string` | `((title: string) => string)`
Configures dynamic template to customize the page title on an individual page.
- `title`
**Type** : `string`
Sets static page title on an individual page.
- `bodyAttrs`
**Type** : `Record<string, any>`
Sets attributes of the `<body>` tag. Each object property is mapped to the corresponding attribute.
- `htmlAttrs`
**Type** : `Record<string, any>`
Sets attributes of the `<html>` tag. Each object property is mapped to the corresponding attribute.
