⚠️
The vite-plugin-ssr project has been renamed Vike.
If you are using vite-plugin-ssr, migrate to Vike.
For new projects, use Vike instead of vite-plugin-ssr.
Vike itself (without extensions) is like vite-plugin-ssr: unopinionated and fully agnostic.

Config

+config.h.js files are part of the V1 design.

List of configurations defined by +config.h.js.

// +config.h.ts

// The list is also available over TypeScript
import type { Config } from 'vite-plugin-ssr/types'

export default {
  // ...
} satisfies Config

Configurations

Page: unknown The root UI component of the page.
route: string | Function The page's route.
prerender: Whether to pre-render the page, and pre-rendering settings.
client: string Additional client entry.
prefetchStaticAssets: Link prefetching settings.

Advanced

Most users don't need to know about these. Usually only used by vike-* packages.

meta: Create new or modify existing configurations.
passToClient: string[] Determines what pageContext properties are sent to the client-side.
clientRouting: boolean Enable Client Routing.
hydrationCanBeAborted: boolean Whether the UI framework allows hydrations to be aborted.

Hooks

onHydrationEnd: client-side Called after the page is hydrated.
onPageTransitionStart: client-side Called before the user navigates to a new page.
onPageTransitionEnd: client-side Called after the user navigates to a new page.
onPrerenderStart: server-side Page-specific hook called when pre-rendering starts.
onBeforePrerenderStart: server-side Global hook called before the whole pre-rendering process starts.

Advanced

Most users don't need to know about these. Usually only used by vike-* packages.

onBeforeRender: server-side (and potentially client-side) Called before the page is rendered, usually for fetching data.
onRenderHtml: server-side Called when page is rendered to HTML on the server-side.
onRenderClient: client-side Called when page is rendered on the client-side.
onBeforeRoute: server (and potentially client-side) Called before the URL is routed to a page.

Custom

New configurations can be created by using meta.

✍ Edit this page