Registry / web-framework / vite-plugin-ssr

vite-plugin-ssr

library0.4.142jsnpmunverified

A Vite plugin for server-side rendering (SSR) that follows the Unix philosophy of doing one thing well. Current stable version is 0.4.142. It provides a lightweight, framework-agnostic SSR solution for Vite, unlike full-featured meta-frameworks like Next.js or Nuxt. It supports file-based routing, data fetching, and hydration. The plugin is actively maintained with frequent releases. Key differentiators: it is a simple Vite plugin rather than a full framework, supports any frontend framework (React, Vue, Svelte, etc.), and integrates seamlessly with existing Vite setups. Requires Node >=16, Vite >=3.1.0, and react-streaming >=0.3.5 (for React).

web-framework http-networking

npm install vite-plugin-ssr

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · VITE-PLUGIN-SSR

vite-plugin-ssr

web-frameworkjavascriptv0.4.142

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–223 runs

build_error

glibc

node 18–223 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

vitePluginSsr

✓ import { vitePluginSsr } from 'vite-plugin-ssr/plugin'

✗ import vitePluginSsr from 'vite-plugin-ssr'

The main export is named, not default. Also, it's imported from 'vite-plugin-ssr/plugin' subpath, not the root.

PageContext

✓ import type { PageContext } from 'vite-plugin-ssr/types'

✗ import { PageContext } from 'vite-plugin-ssr'

PageContext is a type and should be imported from the types subpath. Using value import will cause runtime errors.

usePageContext

✓ import { usePageContext } from 'vite-plugin-ssr/client'

✗ import { usePageContext } from 'vite-plugin-ssr'

Client-side hooks like usePageContext are exported from the client subpath, not the root.

Basic SSR setup with React: plugin configuration, a page component, and a server-side render function.

// vite.config.ts import { defineConfig } from 'vite' import { vitePluginSsr } from 'vite-plugin-ssr/plugin' import react from '@vitejs/plugin-react' export default defineConfig({ plugins: [react(), vitePluginSsr()] }) // pages/index.page.tsx import { usePageContext } from 'vite-plugin-ssr/client' export default function Page() { const { urlParsed } = usePageContext() return <h1>Hello {urlParsed.pathname}</h1> } // renderer/_default.page.server.tsx import { renderToString } from 'react-dom/server' import { PageContext } from 'vite-plugin-ssr/types' import { PageWrapper } from './PageWrapper' export async function render(pageContext: PageContext) { const pageHtml = renderToString( <PageWrapper pageContext={pageContext} /> ) return { pageHtml } }

Debug

Known issues

breakingIn v0.4, the import path changed from 'vite-plugin-ssr' to subpaths like 'vite-plugin-ssr/plugin', 'vite-plugin-ssr/client', etc.

fix

Update imports: use import { vitePluginSsr } from 'vite-plugin-ssr/plugin' instead of 'vite-plugin-ssr'

affects: >=0.4.0

breakingPageContext type import changed from 'vite-plugin-ssr' to 'vite-plugin-ssr/types'

fix

Import PageContext from 'vite-plugin-ssr/types' instead of 'vite-plugin-ssr'

affects: >=0.4.0

deprecatedThe old `render` function signature (pageContext, renderPage) is deprecated; use the new context-based API.

fix

Use async function render(pageContext) with explicit return of { pageHtml } or similar

affects: >=0.4.0

gotchaThe plugin requires Vite >=3.1.0 and Node >=16. Using older versions will cause build failures.

fix

Update Vite to >=3.1.0 and Node to >=16

affects: all

gotchaClient-side code that uses react-streaming must ensure the package is installed as a dependency (not just peer dep).

fix

Run npm install react-streaming

affects: all

Errors

Common errors & fixes

Cannot find module 'vite-plugin-ssr/plugin'

Import path is incorrect; the module is not at the root.

fix

Install latest version and use import { vitePluginSsr } from 'vite-plugin-ssr/plugin'

TypeError: (0 , vitePluginSsr) is not a function

Default import instead of named import from the plugin subpath.

fix

Use import { vitePluginSsr } from 'vite-plugin-ssr/plugin' (curly braces)

Property 'pageContext' does not exist on type 'PageContext'

Using an older type definition or incorrect import path for PageContext.

fix

Import PageContext from 'vite-plugin-ssr/types' and ensure version >=0.4.0

The 'vite-plugin-ssr' plugin requires Vite 3.1 or newer.

Vite version is too old.

fix

Upgrade Vite to >=3.1.0

Upgrade

Version history

0.4.142latest on npm

Audit

Dependencies

react-streamingoptionalEnables streaming SSR for React apps

viterequiredPeer dependency; plugin runs inside Vite's build pipeline

Agent activity

26 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/brillout/vite-plugin-ssr ↗

packagehttps://www.npmjs.com/package/vite-plugin-ssr ↗

homepagehttps://vite-plugin-ssr.com ↗