# react-inliner
> React components rendered and inlined server-side.
Latest version **1.1.0** (published 2015-04-14) · MIT license · 0 weekly downloads
## Install
```sh
npm install react-inliner
pnpm add react-inliner
yarn add react-inliner
bun add react-inliner
```
Provides the command `react-inliner`.
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.1.0 |
| Published | 2015-04-14 |
| First published | 2014-11-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Thomas Parisot |
| Maintainers | oncletom |
| Keywords | react, html, inline |
## Links
- npm: https://www.npmjs.com/package/react-inliner
- Repository: https://github.com/oncletom/react-inliner
- Issues: https://github.com/oncletom/react-inliner/issues
- npm.io page: https://npm.io/package/react-inliner
## Dependencies (5)
- [react](https://npm.io/package/react.md) ^0.12.0
- [yargs](https://npm.io/package/yargs.md) ^1.3.3
- [node-jsx](https://npm.io/package/node-jsx.md) ^0.12.0
- [through2](https://npm.io/package/through2.md) ^0.6.3
- [lodash.defaults](https://npm.io/package/lodash.defaults.md) ^3.1.0
## Alternatives
- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads
## Recent versions
- 1.1.0 (latest) — 2015-04-14
- 1.0.1 — 2014-11-18
- 1.0.0 — 2014-11-18
## README
# react-inliner [](https://travis-ci.org/oncletom/react-inliner)
> React components rendered and inlined server-side.
Stream HTML in, get React-rendered HTML out and improve the SEO and accessibility of your Web pages!
The module is still in its early days and looks forward to be improved.
# Install
```bash
npm install --save react-inliner
```
# How it works
This Node.js module looks for some `data-react-inliner* attributes within HTML content.
It then renders the associated React component and prepends the resulting content into the HTML tag.
```html
My Cool React Single Page App
```
It uses [Streams](http://nodejs.org/api/stream.html) under the hood so the HTML filesize should not matter much.
# Usage
## From the command line
Regular read input
```bash
react-inliner inputFile.html -o outputFile.html
```
By piping HTML in.
```bash
cat inputFile.html | react-inliner -o outputFile.html
```
By piping HTML in and out.
```bash
cat inputFile.html | react-inliner | htmlhint
```
Suppress data reconciliation through the `data-reactid` attribute:
```bash
react-inliner inputFile.html -o outputFile.html --no-reactid
```
Get some help.
```bash
react-inliner --help
```
## In your `package.json`
```json
{
"scripts": {
"build-html": "react-inliner src/index.html -o dist/index.html"
}
}
```
Then run `npm run build-html`.
## As an API
```js
var inliner = require('react-inliner');
fs.createReadStream('src/index.html')
.pipe(inliner({ reactId: false }))
.pipe(fs.createWriteStream('dist/index.html');
```
**Warning**: there is an ugly hack preventing `*.less` files to be processed by the `require()` function.
So it might create a black hole in your app if you use the module API.
# License
The MIT License (MIT)
Copyright © 2014 Thomas Parisot, https://oncletom.io
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
---
_Source: https://npm.io/package/react-inliner · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._