logo
  • Guide
  • Config
  • Plugin
  • API
  • Examples
  • Community
  • Modern.js 2.x Docs
  • English
    • 简体中文
    • English
    • Commands
      File Conventions
      src/
      App.[tj]sx
      entry.[tj]s
      entry.server.[tj]sx
      modern.runtime.[tj]s
      routes/
      *.[server|node].[tj]sx
      api/
      lambda/*.[tj]s
      server/
      modern.server.[tj]s
      shared/
      config/
      html/
      favicon.*
      icon.*
      mock/
      public/
      upload/
      modern.config.[tj]s
      Runtime
      Core
      createRoot
      render
      Router
      router
      SSR
      NoSSR
      renderStreaming
      renderString
      createRequestHandler
      BFF
      useHonoContext
      Utility
      CSS-In-JS API
      Head
      loadable
      📝 Edit this page
      Previous pagerenderStreamingNext pagecreateRequestHandler

      #renderString

      Used for React String SSR to render strings, used in conjunction with createRequestHandler.

      #Usage

      src/entry.server.tsx
      import {
        renderString,
        createRequestHandler,
      } from '@modern-js/runtime/ssr/server';
      
      const handleRequest = async (request, ServerRoot, options) => {
        const body = await renderString(request, <ServerRoot />, options);
      
        return new Response(body, {
          headers: {
            'content-type': 'text/html; charset=utf-8',
          },
        });
      };
      
      export default createRequestHandler(handleRequest);

      #Function Signature

      export type RenderString = (
        request: Request,
        serverRoot: React.ReactElement,
        optinos: RenderOptions,
      ) => Promise<string>;

      #Example

      src/entry.server.tsx
      import {
        renderString,
        createRequestHandler,
      } from '@modern-js/runtime/ssr/server';
      
      const handleRequest = async (request, ServerRoot, options) => {
        // do something before render
        const body = await renderString(request, <ServerRoot />, options);
      
        const newBody = body + '<div>Byte-Dance</div>';
      
        return new Response(newBody, {
          headers: {
            'content-type': 'text/html; charset=utf-8',
          },
        });
      };
      
      export default createRequestHandler(handleRequest);