Server Fragments, Islands & SSR Runtimes¶

Server-rendered component fragments (litestar-vite-plugin/fragments), <litestar-island> progressive hydration adapters (litestar-vite-plugin/fragments/client, /react, /vue, /svelte), and SSR execution transports (litestar-vite-plugin/dev-ssr, /ssr-worker).

litestar-vite-plugin/fragments¶

Package Subpath: ./fragments · Types: ./dist/js/fragments/renderer.d.ts · Source: src/js/src/fragments/renderer.ts

RenderFragmentOptions¶

export interface RenderFragmentOptions

RenderFragmentResult¶

export interface RenderFragmentResult

renderFragment¶

export async function renderFragment(options: RenderFragmentOptions, customImporter?: (specifier: string) => Promise<any>): Promise<RenderFragmentResult>

createFragmentRenderer¶

export function createFragmentRenderer( registry: Record<string, () => Promise<any>>, options: { clientEntry?: string } = {}, ): (params: Record<string, unknown>) => Promise<RenderFragmentResult>

Create a production renderer from imports compiled by the application's SSR build.

litestar-vite-plugin/fragments/client¶

Package Subpath: ./fragments/client · Types: ./dist/js/fragments/client.d.ts · Source: src/js/src/fragments/client.ts

IslandComponent¶

export interface IslandComponent

IslandTeardown¶

export type IslandTeardown = () => void | Promise<void>

IslandHydrator¶

export type IslandHydrator = (component: any, target: HTMLElement, props: Record<string, unknown>) => IslandTeardown | Promise<IslandTeardown>

hydrateIslands¶

export function hydrateIslands(registry: Record<string, IslandComponent>): void

Register compiled component imports and hydrate present and subsequently inserted islands.

litestar-vite-plugin/fragments/react¶

Package Subpath: ./fragments/react · Types: ./dist/js/fragments/react.d.ts · Source: src/js/src/fragments/react.ts

hydrateReact¶

export const hydrateReact: IslandHydrator

litestar-vite-plugin/fragments/vue¶

Package Subpath: ./fragments/vue · Types: ./dist/js/fragments/vue.d.ts · Source: src/js/src/fragments/vue.ts

hydrateVue¶

export const hydrateVue: IslandHydrator

litestar-vite-plugin/fragments/svelte¶

Package Subpath: ./fragments/svelte · Types: ./dist/js/fragments/svelte.d.ts · Source: src/js/src/fragments/svelte.ts

hydrateSvelte¶

export const hydrateSvelte: IslandHydrator

litestar-vite-plugin/dev-ssr¶

Package Subpath: ./dev-ssr · Types: ./dist/js/dev-ssr.d.ts · Source: src/js/src/dev-ssr.ts

litestarViteSsrPlugin¶

export function litestarViteSsrPlugin(options: DevSsrOptions = {}): Plugin

litestar-vite-plugin/ssr-worker¶

Package Subpath: ./ssr-worker · Types: ./dist/js/ssr-worker.d.ts · Source: src/js/src/ssr-worker.ts

SsrWorkerOptions¶

export interface SsrWorkerOptions

IPCRequest¶

export interface IPCRequest

dispatchSsrRequest¶

export async function dispatchSsrRequest(request: IPCRequest, options: SsrWorkerOptions = {}): Promise<unknown>

Dispatch one request, preserving rendering errors for the transport's fallback policy.

startSsrWorker¶

export function startSsrWorker(options: SsrWorkerOptions = {}): void

Start the shared newline-delimited JSON RPC worker for an application's SSR entry.