renderToString

const html = renderToString(reactNode, options?)

• রেফারেন্স
  • renderToString(reactNode, options?)
• ব্যাবহার
  • একটি React tree কে HTML হিসেবে একটি স্ট্রিং-এ রেন্ডার করা
• Alternatives
  • Migrating from renderToString to a streaming method on the server
  • Removing renderToString from the client code
• Troubleshooting
  • When a component suspends, the HTML always contains a fallback

রেফারেন্স

renderToString(reactNode, options?)

আপনার অ্যাপকে HTML এ রেন্ডার করতে, সার্ভার থেকে renderToString কল করুন।

import { renderToString } from 'react-dom/server';

const html = renderToString(<App />);

সার্ভার-জেনারেটেড HTML কে ইন্টার‍্যাক্টিভ করতে, ক্লায়েন্ট থেকে hydrateRoot কল করুন।

নিচে আরো উদাহরণ দেখুন।

প্যারামিটার্স

• reactNode: একটি React node যাকে আপনি HTML এ রেন্ডার করতে চান। উদাহরণস্বরূপ,<App /> এর মতো একটি JSX node ।

• অপশনাল options: সার্ভার রেন্ডারের জন্য একটি অবজেক্ট।

  • অপশনাল identifierPrefix: একটি string prefix (উপসর্গ) যেটি React useId এর দ্বারা জেনারেট করা id এর সঙ্গে ব্যবহার করে। একই পেজে একাধিক root ব্যবহারের সময় আইডির সাথে আইডির সংঘর্ষ এড়াতে এটি উপকারে আসে। এটি hydrateRoot এর কাছে পাস করা prefix এর অবশ্যই অনুরূপ হতে হবে।

রিটার্নস

একটি HTML স্ট্রিং।

সাবধানতা

• renderToString এর সীমিত Suspense সাপোর্ট রয়েছে। যদি কোনো কম্পোনেন্ট suspend করে, renderToString কোনো বিলম্ব ছাড়াই সেটির fallback কে HTML হিসেবে পাঠিয়ে দেয়।

• renderToString ব্রাউজারে কাজ করে, কিন্তু ক্লায়েন্ট সাইডে এটির ব্যাবহার রিকমেন্ডেড না।

ব্যাবহার

একটি React tree কে HTML হিসেবে একটি স্ট্রিং-এ রেন্ডার করা

আপনার সার্ভার রেসপন্সের সাথে পাঠানোর জন্য আপনার অ্যাপকে একটি HTML স্ট্রিং-এ রেন্ডার করতে renderToString কল করুনঃ

import { renderToString } from 'react-dom/server';

// The route handler syntax depends on your backend framework
app.use('/', (request, response) => {
  const html = renderToString(<App />);
  response.send(html);
});

এটি আপনার React কম্পোনেন্টগুলির প্রাথমিক নন-ইন্টারেক্টিভ HTML আউটপুট তৈরি করবে। ক্লায়েন্ট সাইডে, আপনাকে সেই সার্ভার-জেনারেটেড HTML কে হাইড্রেট এবং ইন্টারেক্টিভ করতে hydrateRoot কল করতে হবে।

Alternatives

Migrating from renderToString to a streaming method on the server

renderToString returns a string immediately, so it does not support streaming or waiting for data.

When possible, we recommend using these fully-featured alternatives:

• If you use Node.js, use renderToPipeableStream.
• If you use Deno or a modern edge runtime with Web Streams, use renderToReadableStream.

You can continue using renderToString if your server environment does not support streams.

Removing renderToString from the client code

Sometimes, renderToString is used on the client to convert some component to HTML.

// 🚩 Unnecessary: using renderToString on the client
import { renderToString } from 'react-dom/server';

const html = renderToString(<MyIcon />);
console.log(html); // For example, "<svg>...</svg>"

Importing react-dom/server on the client unnecessarily increases your bundle size and should be avoided. If you need to render some component to HTML in the browser, use createRoot and read HTML from the DOM:

import { createRoot } from 'react-dom/client';
import { flushSync } from 'react-dom';

const div = document.createElement('div');
const root = createRoot(div);
flushSync(() => {
  root.render(<MyIcon />);
});
console.log(div.innerHTML); // For example, "<svg>...</svg>"

The flushSync call is necessary so that the DOM is updated before reading its innerHTML property.

Troubleshooting

When a component suspends, the HTML always contains a fallback

renderToString does not fully support Suspense.

If some component suspends (for example, because it’s defined with lazy or fetches data), renderToString will not wait for its content to resolve. Instead, renderToString will find the closest <Suspense> boundary above it and render its fallback prop in the HTML. The content will not appear until the client code loads.

To solve this, use one of the recommended streaming solutions. They can stream content in chunks as it resolves on the server so that the user sees the page being progressively filled in before the client code loads.