সতর্কতা

renderToString streaming সাপোর্ট করে না এবং ডেটা (ফেচিং বা কোনো এসিংক্রোনাস কাজ) এর জন্য বিলম্ব করে না বিকল্প সমূহ দেখুন।

renderToString একটি React tree কে HTML string হিসেবে রেন্ডার করে।

const html = renderToString(reactNode, options?)

রেফারেন্স

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 কল করতে হবে।

সতর্কতা

renderToString streaming সাপোর্ট করে না এবং ডেটা (ফেচিং বা কোনো এসিংক্রোনাস কাজ) এর জন্য বিলম্ব করে না বিকল্প সমূহ দেখুন।


বিকল্প সমূহ

সার্ভারে renderToString এর বদলে একটি streaming মেথড ব্যাবহার করা

renderToString সঙ্গে সঙ্গেই একটি স্ট্রিং রিটার্ন করে, তাই এটি স্ট্রিমিং বা ডেটার জন্য অপেক্ষা করা সাপোর্ট করে না।

যখন সম্ভব, আমরা এই fully-featured বিকল্পগুলো ব্যাবহার করা রেকমেন্ড করিঃ

  • আপনি যদি Node.js ব্যবহার করেন, তাহলে renderToPipeableStream ব্যবহার করুন।
  • আপনি যদি Deno বা Web Streams সহ একটি আধুনিক Edge রানটাইম ব্যবহার করেন, তাহলে renderToReadableStream ব্যবহার করুন।

আপনার সার্ভার environment যদি stream সাপোর্ট না করে, তাহলে আপনি renderToString ব্যবহার চালিয়ে যেতে পারেন।


সার্ভারে renderToString থেকে static prerender এ migration

renderToString সাথে সাথেই একটি string return করে, তাই এটি static HTML generation এর জন্য data load হওয়ার জন্য অপেক্ষা করাকে support করে না।

আমরা নিচের fully-featured বিকল্পগুলো ব্যবহার করতে recommend করি:

  • যদি আপনি Node.js ব্যবহার করেন, prerenderToNodeStream ব্যবহার করুন।
  • যদি আপনি Deno অথবা Web Streams সহ একটি মডার্ন edge runtime ব্যবহার করেন, prerender ব্যবহার করুন।

যদি আপনার static site generation environment streams support না করে তাহলে আপনি renderToString ব্যবহার করতে থাকতে পারেন।


ক্লায়েন্ট কোড থেকে renderToString দূর করা

কখনো কখনো, কোনো কম্পোনেন্টকে HTML-এ রূপান্তর করতে ক্লায়েন্ট-সাইডে renderToString ব্যবহার করা হয়।

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

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

ক্লায়েন্ট-সাইডে react-dom/server ইমপোর্ট করা বিনা প্রয়োজনে আপনার বান্ডল সাইজ বাড়িয়ে দেয় এবং এটা এড়ানো উচিত। যদি আপনার ব্রাউজারে কোনো কম্পোনেন্টকে HTML-এ রেন্ডার করতে হয়, তাহলে createRoot ব্যবহার করুন এবং DOM থেকে HTML রিড করুনঃ

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>"

এখানে flushSync কল করা জরুরী যাতে DOM তার innerHTML প্রোপার্টি read করার আগে আপডেট হয়।


ট্রাবলশুটিং

যখন একটি কম্পোনেন্ট Suspense এ থাকে, তখন HTML এর সর্বদা একটি ফলব্যাক থাকে

renderToString পুরোপুরি ভাবে Suspense সাপোর্ট করে না।

যদি কোনো কম্পোনেন্ট সাসপেন্স অবস্থায় থাকে (যেমন, যদি এটাকে lazy করা হয় কিংবা এটা ডেটা ফেচ করে), তাহলে এর কন্টেন্ট resolve হওয়ার জন্য renderToString অপেক্ষা করবে না। পরিবর্তে, renderToString উপরের সবচেয়ে কাছের <Suspense> বাউন্ডারি খুঁজে বের করবে এবং HTML-এ এর fallback প্রপ রেন্ডার করবে। ক্লায়েন্ট কোড লোড না হওয়া পর্যন্ত ঐ কন্টেন্ট প্রদর্শিত হবে না।

এটি সমাধান করতে, প্রস্তাবিত streaming solution গুলোর যেকোনো একটি ব্যবহার করুন। Server side rendering এর জন্য, এগুলো content কে chunks আকারে stream করতে পারে যখন সেগুলো server এ resolve হয়, যাতে user client code load হওয়ার আগেই page টি ধীরে ধীরে পূর্ণ হতে দেখে। Static site generation এর জন্য, এগুলো static HTML generate করার আগে সমস্ত content resolve হওয়ার জন্য অপেক্ষা করতে পারে।