preactjs/preact-render-to-string — dự án frontend — đang có 729 sao GitHub trong nhóm Frontend. 📄 Universal rendering for Preact: render JSX and Preact components to HTML.
Tóm tắt dựng từ metadata GitHub của chính dự án — chưa có bài review TopGit. Trang sẽ tự động cập nhật khi bài review đầy đủ được xuất bản.
VÌ SAO CHƯA CÓ REVIEW
TopGit viết bài đầy đủ cho repo có nhiều sao nhất và được yêu cầu nhiều nhất. Trang này là snapshot trong thời gian chờ — xem README gốc ở tab READ ME.
Render JSX and Preact components to an HTML string.
Works in Node & the browser, making it useful for universal/isomorphic rendering.
>> Cute Fox-Related Demo(@ CodePen) <<
Render JSX/VDOM to HTML
import { render } from 'preact-render-to-string';
import { h } from 'preact';
/** @jsx h */
let vdom = <div class="foo">content</div>;
let html = render(vdom);
console.log(html);
// <div class="foo">content</div>
Render Preact Components to HTML
import { render } from 'preact-render-to-string';
import { h, Component } from 'preact';
/** @jsx h */
// Classical components work
class Fox extends Component {
render({ name }) {
return <span class="fox">{name}</span>;
}
}
// ... and so do pure functional components:
const Box = ({ type, children }) => (
<div class={`box box-${type}`}>{children}</div>
);
let html = render(
<Box type="open">
<Fox name="Finn" />
</Box>
);
console.log(html);
// <div class="box box-open"><span class="fox">Finn</span></div>
Render JSX / Preact / Whatever via Express!
import express from 'express';
import { h } from 'preact';
import { render } from 'preact-render-to-string';
/** @jsx h */
// silly example component:
const Fox = ({ name }) => (
<div class="fox">
<h5>{name}</h5>
<p>This page is all about {name}.</p>
</div>
);
// basic HTTP server via express:
const app = express();
app.listen(8080);
// on each request, render and return a component:
app.get('/:fox', (req, res) => {
let html = render(<Fox name={req.params.fox} />);
// send it back wrapped up as an HTML5 document:
res.send(`<!DOCTYPE html><html><body>${html}</body></html>`);
});
Error Boundaries
Rendering errors can be caught by Preact via getDerivedStateFromErrors or componentDidCatch. To enable that feature in preact-render-to-string set errorBoundaries = true
import { options } from 'preact';
// Enable error boundaries in `preact-render-to-string`
options.errorBoundaries = true;
import { Suspense, lazy } from 'preact/compat';
// Creation of the lazy component
const HomePage = lazy(() => import('./pages/home'));
const Main = () => {
return (
<Suspense fallback={<p>Loading</p>}>
<HomePage />
</Suspense>
);
};
import { renderToStringAsync } from 'preact-render-to-string';
import { Main } from './main';
const main = async () => {
// Rendering of lazy components
const html = await renderToStringAsync(<Main />);
console.log(html);
// <h1>Home page</h1>
};
// Execution & error handling
main().catch((error) => {
console.error(error);
});
Streaming
[!NOTE]
This is an early version of our streaming implementation.
Preact supports streaming HTML to the client incrementally, flushing <Suspense> fallbacks immediately and replacing them with the resolved content as data arrives. This reduces Time to First Byte and allows the browser to start parsing earlier.
renderToReadableStream — Web Streams
import { renderToReadableStream } from 'preact-render-to-string/stream';
import { Suspense, lazy } from 'preact/compat';
const Profile = lazy(() => import('./Profile'));
const App = () => (
<html>
<head><title>My App</title></head>
<body>
<Suspense fallback={<p>Loading profile…</p>}>
<Profile />
</Suspense>
</body>
</html>
);
// Works in any Web Streams environment (Deno, Bun, Cloudflare Workers, …)
export default {
fetch() {
const stream = renderToReadableStream(<App />);
// stream.allReady resolves once all suspended content has been flushed
return new Response(stream, {
headers: { 'Content-Type': 'text/html' }
});
}
};
The returned ReadableStream has an extra allReady: Promise<void> property that resolves once every suspended subtree has been written. Await it before sending the response if you need the complete document before anything is flushed (e.g. for static export). At which point you might be better off using renderToStringAsync though.
const stream = renderToReadableStream(<App />);
await stream.allReady; // wait for full render
renderToPipeableStream — Node.js Streams
import { createServer } from 'node:http';
import { renderToPipeableStream } from 'preact-render-to-string/stream-node';
import { Suspense, lazy } from 'preact/compat';
const Profile = lazy(() => import('./Profile'));
const App = () => (
<html>
<head><title>My App</title></head>
<body>
<Suspense fallback={<p>Loading profile…</p>}>
<Profile />
</Suspense>
</body>
</html>
);
createServer((req, res) => {
res.setHeader('Content-Type', 'text/html');
const { pipe, abort } = renderToPipeableStream(<App />, {
onShellReady() {
// Called once the synchronous shell is ready to stream.
pipe(res);
},
onAllReady() {
// Called once every suspended subtree has been flushed.
},
onError(error) {
console.error(error);
res.statusCode = 500;
}
});
// Optional: abort the render after a timeout
setTimeout(abort, 10_000);
}).listen(8080);
Option
Description
onShellReady()
Called synchronously once the initial shell has been rendered and streaming is about to start. Pipe here for fastest TTFB.
onAllReady()
Called after all <Suspense> boundaries have resolved and the stream is complete.
onError(error)
Called for render errors inside suspended subtrees.
Calling abort() stops the render and destroys the stream; any pending suspended subtrees are dropped.
Đọc thêm về preactjs/preact-render-to-string ở đâu?
Trang TopGit này là một snapshot — tab "Readme" hiển thị nguyên văn README của repo (đã bỏ link, giữ ảnh). Repo GitHub ở github.com/preactjs/preact-render-to-string là nguồn chính thức.
preactjs/preact-render-to-string có bao nhiêu sao?
preactjs/preact-render-to-string có 729 sao GitHub — tải lại trang để xem số mới nhất, hoặc xem trực tiếp github.com/preactjs/preact-render-to-string. TopGit phản chiếu số sao của GitHub nhưng không cam kết đến từng phút.
preactjs/preact-render-to-string có những chủ đề gì?
GitHub topics của preactjs/preact-render-to-string: "html", "preact", "preact-components", "universal". TopGit xếp repo vào nhóm Frontend.
preactjs/preact-render-to-string có trang demo không?
Dự án có trang chủ ở http://npm.im/preact-render-to-string. Tab "Readme" ở trang này thường có ảnh chụp và hướng dẫn bắt đầu nhanh.
preactjs/preact-render-to-string còn đang phát triển không?
Commit gần nhất trên preactjs/preact-render-to-string là 12 ngày trước (theo timestamp GitHub). Repo có 102 fork — một chỉ báo về mức độ quan tâm của cộng đồng.
preactjs/preact-render-to-string dùng license gì?
preactjs/preact-render-to-string phát hành theo license MIT. Nên mở file LICENSE trên GitHub để xác nhận — license metadata đôi khi lệch với thực tế dự án.
preactjs/preact-render-to-string viết bằng ngôn ngữ gì?
preactjs/preact-render-to-string chủ yếu viết bằng JavaScript. Trường "language" của GitHub dựa trên phần lớn byte ở nhánh mặc định.
Đọc đầy đủ README ở tab phía trên.
Muốn nghe thêm một ý kiến về preact-render-to-string?
Hỏi một AI đọc được trang này — một cú bấm là có ngay nhận định về preact-render-to-string.