NO LONGER MAINTAINED

gulp-render-react

Render React components to string or static markup

Will render React component with ReactDOMServer.renderToString or ReactDOMServer.renderToStaticMarkup

Install

$ npm install --save-dev gulp-render-react

Usage

var gulp = require('gulp');
var render = require('gulp-render-react');

var SRC = 'src/*.js';
var DEST = 'dist';

gulp.task('default', function () {
  return gulp.src(SRC, { read: false })
    .pipe(render({
      type: 'string',
      props: {
        some: 'default'
        props: 'to',
        pass: 'on'
      }
    }))
    .pipe(gulp.dest(DEST));
});

API

render(opts)

• type is
  • string for ReactDOMServer.renderToString()
  • markup for ReactDOMServer.renderToStaticMarkup()
• props are the properties to create the component with

Usage with React Router

src/app.js

import React, { Component, PropTypes } from 'react';
import { createMemoryHistory, Router, Route, IndexRoute } from 'react-router';

class App extends Component {
  render() {
    return (
      <div>
        <h1>App</h1>
        {this.props.children}
      </div>
    );
  }
}

class Home extends Component {
  render() {
    return (
      <h2>Home</h2>
    );
  }
}

class About extends Component {
  render() {
    return (
      <h2>About</h2>
    );
  }
}

class MyRouter extends Component {
  static propTypes = {
    location: PropTypes.string,
  };

  static defaultProps = {
    location: '/',
  };

  render() {
    const history = createMemoryHistory(this.props.location);

    return (
      <Router history={history}>
        <Route path="/" component={App}>
          <IndexRoute component={Home} />
          <Route path='home' component={Home} />
          <Route path='about' component={About} />
        </Route>
      </Router>
    );
  }
}

export default MyRouter;

Gulpfile.js

var gulp = require('gulp');
var render = require('gulp-render-react');

var SRC = 'src/*.js';
var DEST = 'dist';

gulp.task('default', function () {
  return gulp.src(SRC, { read: false })
    .pipe(render({
      type: 'string',
      props: {
        location: 'home'
      }
    }))
    .pipe(gulp.dest(DEST));
});

License

Copyright (c) 2014-2017 Andrew Shapro

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.