❤
npm
Sign UpSign In

This package has been deprecated

Author message:

This package is out of date and doesn't supported

express-react-view-engine

0.4.1 • Public • Published

express-react-view-engine

This is fork of Express view engine(which created by @zpao).

This is an Express view engine which renders React components on server. It renders markup and it supports mounting those views on the client.

This is intended to be used as a replacement for existing server-side view solutions, like jade, ejs, or handlebars.

Usage

npm install express-react-view-engine react

Note: You must explicitly install react as a dependency. Starting in v0.5, react is a peer dependency here. This is to avoid issues that may come when using incompatible versions.

Add it to your app.

// app.js
 
var app = express();
 
app.set('view engine', 'jsx');
app.engine('jsx', require('express-react-view-engine').createEngine());

Options

Beginning with v0.2, you can now pass options in when creating your engine.

option values default
jsx.harmony true: enable a subset of ES6 features false
jsx.extension any file extension with leading . ".jsx"
doctype any string that can be used as a doctype, this will be prepended to your document "<!DOCTYPE html>"
beautify true: beautify markup before outputting (note, this can affect rendering due to additional whitespace) false

The defaults are sane, but just in case you want to change something, here's how it would look:

var options = { jsx: { harmony: true } };
app.engine('jsx', require('express-react-views').createEngine(options));

Views

Your views should be node modules that export a React component. Let's assume you have this file in views/index.jsx:

/** @jsx React.DOM */
 
var HelloMessage = React.createClass({
  render: function() {
    return <div>Hello {this.props.name}</div>;
  }
});
 
module.exports = HelloMessage

Routes

Your routes would look identical to the default routes Express gives you out of the box.

// app.js
 
app.get('/', require('./routes').index);
// routes/index.js
 
exports.index = function(req, res){
  res.render('index', { name: 'John' });
};

That's it! Layouts follow really naturally from the idea of composition.

Layouts

Simply pass the relevant props to a layout component.

views/index.jsx:

/** @jsx React.DOM */
 
var HelloMessage = React.createClass({
  render: function() {
    return (
      <div>Hello {this.props.name}</div>
    );
  }
});
 
module.exports = HelloMessage;

Questions

What about partials & includes?

These ideas don't really apply. But since they are familiar ideas to people coming from more traditional "templating" solutions, let's address it. Most of these can be solved by packaging up another component that encapsulates that piece of functionality.

What about view helpers?

I know you're used to registering helpers with your view helper (hbs.registerHelper('something', ...))) and operating on strings. But you don't need to do that here.

  • Many helpers can be turned into components. Then you can just require and use them in your view.
  • You have access to everything else in JS. If you want to do some date formatting, you can require('moment') and use directly in your view. You can bundle up other helpers as you please.

Where does my data come from?

All "locals" are exposed to your view in this.props. These should work identically to other view engines, with the exception of how they are exposed. Using this.props follows the pattern of passing data into a React component, which is why we do it that way. Remember, as with other engines, rendering is synchronous. If you have database access or other async operations, they should be done in your routes.

Caveats

  • This currently uses require to access your views. This means that contents are cached for the lifetime of the server process. You need to restart your server when making changes to your views. In development, we clear your view files from the cache so you can simply refresh your browser to see changes.
  • React & JSX have their own rendering caveats. For example, inline <script>s and <style>s will need to use dangerouslySetInnerHTML={{__html: 'script content'}}. You can take advantage of ES6 template strings here.
<script dangerouslySetInnerHTML={{__html: `
  // google analtyics
  // is a common use
`}} />
  • It's not possible to specify a doctype in JSX. You can override the default HTML5 doctype in the options.

Readme

Keywords

Package Sidebar

Install

npm i express-react-view-engine

Repository

github.com/Zemelia/express-react-view-engine

Homepage

github.com/Zemelia/express-react-view-engine

Weekly Downloads

1

Version

0.4.1

License

BSD-2-Clause

Last publish

Collaborators

  • snig
  • zemelia
Try on RunKit
Report malware