Saltar al contenido
Meeko
Escribe para buscar en las guías y en la referencia de la API. Ábrela desde cualquier página con / o Ctrl K; muévete con las flechas y entra con Intro.
Empezar

Contenidos

En esta página

DocumentConfig

interfaz Desde 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.

ts
import type { DocumentConfig } from "@meekojs/meeko/framework";

Código fuente src/shared/head.ts:234

Declaración #

ts
interface DocumentConfig {
	lang?: string
	head?: DocumentHead
	seo?: boolean | DocumentSeo
	theme?: ThemeConfig
	idPrefix?: string
}

Ejemplo #

ts
// 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 #

lang #

propiedad opcional

lang?: string

Atributo lang de <html>; head.htmlAttrs.lang tiene prioridad.

propiedad opcional

Etiquetas 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 #

propiedad opcional desde 1.3.0

seo?: boolean | DocumentSeo

Etiquetas 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 #

propiedad opcional desde 1.4.0

theme?: ThemeConfig

Tema 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 #

propiedad opcional desde 1.5.0

idPrefix?: string

Prefijo 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.

Véase también #

¿Te sirvió esta página?

Añadir un comentario

Se envía al elegir «Sí» o «No». Solo se guardan la página, tu respuesta y el comentario: ni cookies ni datos tuyos.

0 de 2000 caracteres

Editar en GitHub: packages/meeko/src/shared/head.ts