DocumentConfig
interfaz Since 1.2.0
Documento de la aplicación: document de meeko.config.ts. Se renderiza en cada documento HTML
(SSR, stream, prerender, páginas de error y render: "client") con la menor prioridad, así que
cualquier useHead o head de página lo sustituye. Se fija en el build, así que
head.titleTemplate debe ser una cadena (véase DocumentHead).
head.title es el título del sitio y no pasa por head.titleTemplate: una página sin título
propio (o con un título vacío) muestra head.title tal cual, y una página con título muestra el
suyo con la plantilla. La misma regla se aplica en el servidor y al navegar en el cliente.
import type { DocumentConfig } from "@meekojs/meeko/framework";Source code src/shared/head.ts:234
Declaración #
interface DocumentConfig {
lang?: string
head?: DocumentHead
seo?: boolean | DocumentSeo
theme?: ThemeConfig
idPrefix?: string
}Example #
// meeko.config.ts
import { defineMeekoConfig } from "@meekojs/meeko/framework";
export default defineMeekoConfig({
document: {
lang: "es",
head: {
// «Precios - Mi Sitio» en /precios; «Mi Sitio» en una página sin título.
title: "Mi Sitio",
titleTemplate: "%s - Mi Sitio",
link: [{ rel: "icon", href: "/favicon.svg", type: "image/svg+xml" }],
},
},
});Propiedades #
head
#
head?: DocumentHeadEtiquetas y atributos comunes a todos los documentos. title es el título del sitio, sin
plantilla; titleTemplate, una cadena con %s, se aplica a los títulos de las páginas.
seo
#
seo?: boolean | DocumentSeoEtiquetas de SEO que dependen de cada página: con true, <link rel="canonical"> y og:url
con el origen de site (o MEEKO_PUBLIC_ORIGIN del build) y la ruta, y og:title y
og:description con el título y la descripción finales. Una página que declara cualquiera de
ellas (con useSeoMeta, useHead o su head) la sustituye. Las páginas de error no reciben
canonical ni og:url.
theme
#
theme?: ThemeConfigTema claro/oscuro de la aplicación. El build lo copia de theme de meeko.config.ts, con
todas sus opciones decididas (en meeko.config.ts se escribe en theme, no aquí); un host
propio que pasa DocumentOptions.config y mountClientApp({ document }) lo da aquí.
idPrefix
#
idPrefix?: stringPrefijo de los IDs de useId (y de form.field): una letra seguida de letras, números, - o
_, hasta 32 caracteres. Por defecto, m. Distíngalo cuando dos aplicaciones Meeko compartan
una página.