nuxt logo

Tradução da Documentação (Não Oficial)

useHead

useHead personaliza as propriedades do head de páginas individuais do seu aplicativo Nuxt.

A função composable useHead permite que você gerencie suas tags head de maneira programática e reativa, alimentada pelo Unhead. Se os dados vierem de um usuário ou outra fonte não confiável, recomendamos que você confira useHeadSafe.

Veja também getting-started > seo-meta

Tipo

useHead(meta: MaybeComputedRef<MetaObject>): void

Abaixo estão os tipos não reativos para 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
}

Veja @unhead/vue para tipos mais detalhados.

As propriedades de useHead podem ser dinâmicas, aceitando propriedades ref, computed e reactive. O parâmetro meta também pode aceitar uma função que retorna um objeto para tornar o objeto inteiro reativo.

Parâmetros

meta

Tipo: MetaObject

Um objeto que aceita os seguintes metadados do head:

  • meta: Cada elemento no array é mapeado para uma nova tag <meta>, onde as propriedades do objeto são mapeadas para os atributos correspondentes.
    • Tipo: Array<Record<string, any>>
  • link: Cada elemento no array é mapeado para uma nova tag <link>, onde as propriedades do objeto são mapeadas para os atributos correspondentes.
    • Tipo: Array<Record<string, any>>
  • style: Cada elemento no array é mapeado para uma nova tag <style>, onde as propriedades do objeto são mapeadas para os atributos correspondentes.
    • Tipo: Array<Record<string, any>>
  • script: Cada elemento no array é mapeado para uma nova tag <script>, onde as propriedades do objeto são mapeadas para os atributos correspondentes.
    • Tipo: Array<Record<string, any>>
  • noscript: Cada elemento no array é mapeado para uma nova tag <noscript>, onde as propriedades do objeto são mapeadas para os atributos correspondentes.
    • Tipo: Array<Record<string, any>>
  • titleTemplate: Configura um template dinâmico para personalizar o título da página em uma página individual.
    • Tipo: string | ((title: string) => string)
  • title: Define o título estático da página em uma página individual.
    • Tipo: string
  • bodyAttrs: Define os atributos da tag <body>. Cada propriedade do objeto é mapeada para o atributo correspondente.
    • Tipo: Record<string, any>
  • htmlAttrs: Define os atributos da tag <html>. Cada propriedade do objeto é mapeada para o atributo correspondente.
    • Tipo: Record<string, any>