Head and document

#Concept

Head components. <Title>, <Meta> and <Head> can be used in any component, layout or page. There is no meta export: these components are the one way to set head content.

• <Title>: the deepest one wins, so a page overrides its layouts and the document.
• <Meta name="…" content="…" />: attributes as in HTML. Metas with the same charset, name, property, http-equiv or itemprop dedupe: the deepest one wins, and the previous value comes back when it is removed.
• <Head>: any other head elements (<link>, <script>). Elements already in <head> are not duplicated; while hydrating, the server's copy belongs to the component and goes with it.

On the server they are collected while the shell renders and flushed into <head>. Inside a streamed <Suspense> boundary they are too late (LUM5004). In the browser (islands, SPA) they update document.title and <head> live, and are removed with their component: the previous value comes back, or the head default (below) when the last one of a key goes.

Document. By default Lumiose renders the HTML document. src/document.stsx takes over <html>, <head> and <body>: it receives { head, body } and must render each once. It renders like any component, so it can provide context to pages. {props.head} also carries the page's stylesheets, preload hints and island loader. {props.body} is followed by the page's island records and its streamed <Suspense> content, so the whole page stays inside <body> with either document.

Head defaults. The <title> and <meta> tags the document writes in its <head> are defaults, the shallowest level of the head: a <Title> replaces the title, and a <Meta> replaces the tag with the same charset, name, property, http-equiv or itemprop, where the document put it. Each page gets one of each, in complete and streamed responses. The default document's charset and viewport tags work the same way. After an SPA navigation to a page without its own <Title> or <Meta> of a key, the default comes back, as the server would render that page: a tag that replaced a default carries it in a data-l-default attribute. The same goes for the <Title> and <Meta> of layouts outside the SPA (the ones the server renders around it), except where the page that loaded the document replaced them; SPA-wide defaults belong in the document or the outermost spa layout.

Status: available on the server (renderToStream) and in the browser; the default and custom documents are rendered by the request handler.

#API

#Example

// src/document.stsx: the title and description are defaults that pages replace
import type { DocumentProps } from "lumiose";

export default function Document(props: DocumentProps) {
  return (
    <html lang="en">
      <head>
        <meta charset="utf-8" />
        <meta name="viewport" content="width=device-width, initial-scale=1" />
        <title>A Lumiose site</title>
        <meta name="description" content="A Lumiose site" />
        {props.head}
      </head>
      <body>{props.body}</body>
    </html>
  );
}

// src/routes/about/page.tsx
import { Head, Meta, Title } from "lumiose";

export default function About() {
  return (
    <main>
      <Title>About us</Title>
      <Meta name="description" content="Who we are" />
      <Head>
        <link rel="canonical" href="https://example.com/about" />
      </Head>
      <h1>About us</h1>
    </main>
  );
}

#Common mistakes

• A meta or title export. There is none; render <Title> and <Meta>.
• <Title> inside <Suspense> on a server route: the head was already sent (LUM5004). Set it in the page body outside the boundary.
• Rendering props.head or props.body twice in document.stsx. Render each exactly once.
• Writing <title> or <meta> elements directly in a page. They land in the body. Use the components.
• Setting document.title in an effect. It fights with <Title>; use the component.

#Related diagnostics

• LUM5004: head or status change inside a streamed boundary.

See also: Rendering modes, reference: components.