gulp-react-render
v2.0.1
Published
gulp plugin for react components rendering in existing markup
Downloads
5
Readme
gulp-react-render
Gulp plugin for rendering reactjs components in existing markup
Installation
npm install gulp-react-renderUsage
var react_render = require('gulp-react-render');
gulp.task('prerender', function() {
gulp.src('./src/*.html')
.pipe(react_render())
.pipe(gulp.dest('./public/'))
});Overview
Lets assume you creating some static site with html pages and have some react component:
//path - ./component/component1.js
React = require('react');
Comp1 = React.createClass({
render: function(){
return React.DOM.div({id: "comp1", className: "test"}, "testDiv")
}
});
module.exports = Comp1Here is our source markup:
<!DOCTYPE html>
<html lang="en">
<head></head>
<body>
<h1>Header ...</h1>
<!-- placing path to component file in data-rcomp attribute -->
<div data-rcomp="./component/component1.js" id="container"></div>
<script type="javascript">
//some init logic
</script>
</body>
</html>After processing we will recieve:
<!DOCTYPE html>
<html lang="en">
<head></head>
<body>
<h1>Header ...</h1>
<!-- placing path to component file in data-rcomp attribute -->
<div data-rcomp="./component/component1.js" id="container">
<div id="comp1" class="test" data-reactid=".1vufboq169s" data-react-checksum="1034950555">testDiv</div>
</div>
<script type="javascript">
//some init logic
</script>
</body>
</html>So, as you may understood this plugin will iterate through all over the components and will call React.renderComponentToString for each component.
Using props
You can pass props to React object adding json to the data-rprop attribute, exe:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
</head>
<body>
<div class="container">
<div data-rcomp="./test/fixtures/comp1" data-rprop="{"p1":"val1"}" id="container"></div>
</div>
</body></html>Rember to encode HTML special chars.
Using props from json file
If you have many properties, it can be better to put the data into an extra json file. This can be done with the data-rpropfile attribute, e.g.:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
</head>
<body>
<div class="container">
<div data-rcomp="./test/fixtures/comp1" data-rpropfile="./test/fixtures/comp1.json" id="container"></div>
</div>
</body>
</html>