You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
85 lines
3.2 KiB
85 lines
3.2 KiB
8 years ago
|
---
|
||
|
id: react-dom-server
|
||
|
title: ReactDOMServer
|
||
|
layout: docs
|
||
|
category: Reference
|
||
|
permalink: docs/react-dom-server.html
|
||
|
---
|
||
|
|
||
7 years ago
|
The `ReactDOMServer` object enables you to render components to static markup. Typically, it's used on a Node server:
|
||
|
|
||
|
```js
|
||
|
// ES modules
|
||
|
import ReactDOMServer from 'react-dom/server';
|
||
|
// CommonJS
|
||
|
var ReactDOMServer = require('react-dom/server');
|
||
|
```
|
||
|
|
||
8 years ago
|
## Overview
|
||
|
|
||
7 years ago
|
The following methods can be used in both the server and browser environments:
|
||
|
|
||
|
- [`renderToString()`](#rendertostring)
|
||
|
- [`renderToStaticMarkup()`](#rendertostaticmarkup)
|
||
|
|
||
|
These additional methods depend on a package (`stream`) that is **only available on the server**, and won't work in the browser.
|
||
8 years ago
|
|
||
7 years ago
|
- [`renderToNodeStream()`](#rendertonodestream)
|
||
|
- [`renderToStaticNodeStream()`](#rendertostaticnodestream)
|
||
8 years ago
|
|
||
|
* * *
|
||
|
|
||
|
## Reference
|
||
|
|
||
|
### `renderToString()`
|
||
|
|
||
|
```javascript
|
||
|
ReactDOMServer.renderToString(element)
|
||
|
```
|
||
|
|
||
7 years ago
|
Render a React element to its initial HTML. React will return an HTML string. You can use this method to generate HTML on the server and send the markup down on the initial request for faster page loads and to allow search engines to crawl your pages for SEO purposes.
|
||
8 years ago
|
|
||
7 years ago
|
If you call [`ReactDOM.hydrate()`](/docs/react-dom.html#hydrate) on a node that already has this server-rendered markup, React will preserve it and only attach event handlers, allowing you to have a very performant first-load experience.
|
||
8 years ago
|
|
||
|
* * *
|
||
|
|
||
|
### `renderToStaticMarkup()`
|
||
|
|
||
|
```javascript
|
||
|
ReactDOMServer.renderToStaticMarkup(element)
|
||
|
```
|
||
|
|
||
|
Similar to [`renderToString`](#rendertostring), except this doesn't create extra DOM attributes such as `data-reactid`, that React uses internally. This is useful if you want to use React as a simple static page generator, as stripping away the extra attributes can save lots of bytes.
|
||
7 years ago
|
|
||
|
* * *
|
||
|
|
||
|
### `renderToNodeStream()`
|
||
|
|
||
|
```javascript
|
||
|
ReactDOMNodeStream.renderToNodeStream(element)
|
||
|
```
|
||
|
|
||
|
Render a React element to its initial HTML. Returns a [Readable stream](https://nodejs.org/api/stream.html#stream_readable_streams) that outputs an HTML string. The HTML output by this stream is exactly equal to what [`ReactDOMServer.renderToString`](#rendertostring) would return.
|
||
|
|
||
|
> Note:
|
||
|
>
|
||
|
> Server-only. This API is not available in the browser.
|
||
|
>
|
||
|
> The stream returned from this method will return a byte stream encoded in utf-8. If you need a stream in another encoding, take a look a project like [iconv-lite](https://www.npmjs.com/package/iconv-lite), which provides transform streams for transcoding text.
|
||
|
|
||
|
* * *
|
||
|
|
||
|
### `renderToStaticNodeStream()`
|
||
|
|
||
|
```javascript
|
||
|
ReactDOMNodeStream.renderToStaticNodeStream(element)
|
||
|
```
|
||
|
|
||
|
Similar to [`renderToNodeStream`](#rendertonodestream), except this doesn't create extra DOM attributes such as `data-reactid`, that React uses internally. The HTML output by this stream is exactly equal to what [`ReactDOMServer.renderToStaticMarkup`](#rendertostaticmarkup) would return.
|
||
|
|
||
|
> Note:
|
||
|
>
|
||
|
> Server-only. This API is not available in the browser.
|
||
|
>
|
||
|
> The stream returned from this method will return a byte stream encoded in utf-8. If you need a stream in another encoding, take a look a project like [iconv-lite](https://www.npmjs.com/package/iconv-lite), which provides transform streams for transcoding text.
|