Nuxt Nation 大会即将到来。加入我们,时间为 11 月 12 日至 13 日。

useHead

useHead 用于自定义 Nuxt 应用中各个页面的头部属性。

可组合函数 useHead 允许您以编程和响应式的方式管理头部标签,由 Unhead 提供支持。如果数据来自用户或其他不受信任的来源,我们建议您查看 useHeadSafe

文档 > 入门 > SEO 元数据 中了解更多信息。

类型

useHead(meta: MaybeComputedRef<MetaObject>): void

以下是 useHead 的非响应式类型。

interface MetaObject {
  title?: string
  titleTemplate?: string | ((title?: string) => string)
  base?: Base
  link?: Link[]
  meta?: Meta[]
  style?: Style[]
  script?: Script[]
  noscript?: Noscript[]
  htmlAttrs?: HtmlAttributes
  bodyAttrs?: BodyAttributes
}

查看 @unhead/schema 以获取更详细的类型。

useHead 的属性可以是动态的,接受 refcomputedreactive 属性。meta 参数还可以接受一个返回对象的函数,以使整个对象具有响应性。

参数

meta

类型: MetaObject

一个接受以下头部元数据的对象

  • meta: 数组中的每个元素都映射到一个新创建的 <meta> 标签,其中对象的属性映射到相应的属性。
    • 类型: Array<Record<string, any>>
  • link: 数组中的每个元素都映射到一个新创建的 <link> 标签,其中对象的属性映射到相应的属性。
    • 类型: Array<Record<string, any>>
  • style: 数组中的每个元素都映射到一个新创建的 <style> 标签,其中对象的属性映射到相应的属性。
    • 类型: Array<Record<string, any>>
  • script: 数组中的每个元素都映射到一个新创建的 <script> 标签,其中对象的属性映射到相应的属性。
    • 类型: Array<Record<string, any>>
  • noscript: 数组中的每个元素都映射到一个新创建的 <noscript> 标签,其中对象的属性映射到相应的属性。
    • 类型: Array<Record<string, any>>
  • titleTemplate: 配置动态模板以自定义单个页面的页面标题。
    • 类型: string | ((title: string) => string)
  • title: 在单个页面上设置静态页面标题。
    • 类型: string
  • bodyAttrs: 设置 <body> 标签的属性。每个对象属性都映射到相应的属性。
    • 类型: Record<string, any>
  • htmlAttrs: 设置 <html> 标签的属性。每个对象属性都映射到相应的属性。
    • 类型: Record<string, any>