feat: +react.renderToStreamOptions (closes vikejs/vike#3137)

examples/full/package.json

@@ -10,7 +10,7 @@
     "@vitejs/plugin-react": "^5.1.1",
     "react": "^19.2.1",
     "react-dom": "^19.2.1",
-    "react-streaming": "^0.4.15",
+    "react-streaming": "^0.4.16",
     "typescript": "^5.9.3",
     "vike": "^0.4.253",
     "vike-react": "0.6.20",

packages/vike-react-apollo/package.json

@@ -36,7 +36,7 @@
     "react": "^19.2.1",
     "react-dom": "^19.2.1",
     "@types/react-dom": "^19.1.9",
-    "react-streaming": "^0.4.15",
+    "react-streaming": "^0.4.16",
     "rimraf": "^5.0.5",
     "typescript": "^5.9.2",
     "vike": "^0.4.253",

packages/vike-react-query/package.json

@@ -36,7 +36,7 @@
     "jsdom": "^24.0.0",
     "react": "^19.2.1",
     "react-dom": "^19.2.1",
-    "react-streaming": "^0.4.15",
+    "react-streaming": "^0.4.16",
     "rimraf": "^5.0.5",
     "typescript": "^5.9.2",
     "vike": "^0.4.253",

packages/vike-react-zustand/package.json

@@ -36,7 +36,7 @@
     "typescript": "^5.9.2",
     "vike": "^0.4.253",
     "vike-react": "0.6.20",
-    "react-streaming": "^0.4.15",
+    "react-streaming": "^0.4.16",
     "vite": "^7.3.0",
     "zustand": "^5.0.3"
   },

packages/vike-react/package.json

@@ -31,7 +31,7 @@
     "./__internal/integration/Loading": "./dist/integration/Loading.js"
   },
   "dependencies": {
-    "react-streaming": "^0.4.15"
+    "react-streaming": "^0.4.16"
   },
   "peerDependencies": {
     "react": ">=19",

packages/vike-react/src/integration/onRenderHtml.tsx

@@ -72,7 +72,7 @@ async function renderPageToHtml(pageContext: PageContextServer) {
   // https://github.com/vikejs/vike-react/issues/87#issuecomment-2488742744
   await callCumulativeHooks(pageContext.config.onBeforeRenderHtml, pageContext)
 
-  const { renderToStringOptions } = resolveReactOptions(pageContext)
+  const { renderToStringOptions, renderToStreamOptions } = resolveReactOptions(pageContext)
 
   if (pageContext.page) {
     const streamSetting = resolveStreamSetting(pageContext)
@@ -101,6 +101,7 @@ async function renderPageToHtml(pageContext: PageContextServer) {
               false,
               */
               undefined,
+        ...renderToStreamOptions,
       })
       pageContext.pageHtmlStream = pageHtmlStream
     }

packages/vike-react/src/integration/resolveReactOptions.ts

@@ -22,6 +22,7 @@ function resolveReactOptions(pageContext: PageContext) {
           // @ts-ignore
           optionsAcc[fnName][key] = (...args: unknown[]) => {
             valPrevious?.(...args)
+            // @ts-ignore
             val(...args)
           }
         }

packages/vike-react/src/types/Config.ts

@@ -5,6 +5,7 @@ import type { ConfigsCumulative } from '../hooks/useConfig/configsCumulative.js'
 import type React from 'react'
 import type { HydrationOptions, RootOptions } from 'react-dom/client'
 import type { ServerOptions } from 'react-dom/server'
+import type { RenderToStreamOptions } from 'react-streaming/server'
 
 // https://vike.dev/meta#typescript
 declare global {
@@ -300,7 +301,32 @@ export type ConfigViaHookResolved = Omit<ConfigViaHook, ConfigsCumulative> &
   Pick<Vike.ConfigResolved, ConfigsCumulative>
 
 export type ReactOptions = {
+  /**
+   * Options passed to React's `hydrateRoot()`.
+   *
+   * https://react.dev/reference/react-dom/client/hydrateRoot
+   * https://vike.dev/react-setting
+   */
   hydrateRootOptions?: HydrationOptions
+  /**
+   * Options passed to React's `createRoot()`.
+   *
+   * https://react.dev/reference/react-dom/client/createRoot
+   * https://vike.dev/react-setting
+   */
   createRootOptions?: RootOptions
+  /**
+   * Options passed to React's `renderToString()`.
+   *
+   * https://react.dev/reference/react-dom/server/renderToString
+   * https://vike.dev/react-setting
+   */
   renderToStringOptions?: ServerOptions
+  /**
+   * Options passed to `react-streaming`'s `renderToStream()` during SSR streaming.
+   *
+   * https://github.com/brillout/react-streaming#options
+   * https://vike.dev/react-setting
+   */
+  renderToStreamOptions?: RenderToStreamOptions
 }