Svelte
You're viewing Unhead v3 beta documentation. Install with unhead@beta
Core Concepts

Streaming SSR

v3 Only - Streaming support is only available in Unhead v3 (currently in beta). This API is experimental and may change.

Standard SSR waits for everything to render before sending HTML. Streaming sends the document shell immediately, then streams content as async components resolve.

The problem: async components using useHead() set head tags after the initial render. Without streaming support, those tags never reach the client's <head>.

Unhead's streaming integration solves this by injecting <script> patches into the stream as content resolves, updating the <head> in real-time.

How It Works

  1. Shell renders - Initial <head> tags render with the document shell
  2. Async content resolves - Components call useHead()
  3. Patches stream - Unhead injects DOM updates as inline scripts
  4. Client hydrates - The client head instance picks up the final state

Setup

Vite Plugin

The plugin transforms your components to enable streaming head updates:

// vite.config.ts
import { unheadSveltePlugin } from '@unhead/svelte/stream/vite'
import { svelte } from '@sveltejs/vite-plugin-svelte'
import { defineConfig } from 'vite'

export default defineConfig({
  plugins: [
    svelte(),
    unheadSveltePlugin(),
  ],
})

Server Entry

// entry-server.ts
import { render as _render } from 'svelte/server'
import { createStreamableHead, UnheadContextKey } from '@unhead/svelte/stream/server'
import App from './App.svelte'

export async function render(url: string, template: string) {
  const { head, wrapStream } = createStreamableHead()
  const context = new Map()
  context.set(UnheadContextKey, head)

  const rendered = await _render(App, {
    props: { url },
    context,
  })

  const svelteStream = new ReadableStream({
    start(controller) {
      controller.enqueue(new TextEncoder().encode(rendered.body))
      controller.close()
    },
  })

  return wrapStream(svelteStream, template)
}

Client Entry

// entry-client.ts
import { mount } from 'svelte'
import { createStreamableHead, UnheadContextKey } from '@unhead/svelte/stream/client'
import App from './App.svelte'

const head = createStreamableHead()
const context = new Map()
context.set(UnheadContextKey, head)

mount(App, {
  target: document.getElementById('app')!,
  context,
})

Usage

Use useHead() normally in your components. Tags stream automatically as async content resolves:

<script lang="ts">
import { useHead } from '@unhead/svelte'

const { data } = $props()

useHead({
  title: data.title,
  meta: [
    { name: 'description', content: data.description }
  ]
})
</script>

<div>{data.content}</div>

When to Skip

If your Svelte SSR is fully synchronous, stick with standard SSR. The streaming setup adds complexity for no benefit when all head tags are available at initial render.

Did this page help you?