@joepie91/express-react-views
v2.0.0
Published
This is (a fork of) an Express view engine which renders React components on server. It renders static markup and *does not* support mounting those views on the client.
Downloads
7
Readme
@joepie91/express-react-views
This is an Express view engine which renders React components on server. It renders static markup and does not support 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.
License
This is a fork of the express-react-views library, which is originally released under the BSD license. The conditional patent grant included in this repository only applies to the parts of the codebase that originate from the original library.
Any changes or additions introduced in this fork may also be used under the WTFPL or CC0 license. If you make a contribution to this fork, other than merging in upstream changes, you agree that your contributions may be used under the WTFPL and CC0 licenses as well.
Usage
npm install express-react-views react react-domNote: 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('views', __dirname + '/views');
app.set('view engine', 'jsx');
app.engine('jsx', require('express-react-views').createEngine());Options
Beginning with v0.2, you can now pass options in when creating your engine.
option | values | default
-------|--------|--------
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
transformViews | true: use babel to apply JSX, ESNext transforms to views.Note: if already using babel-register in your project, you should set this to false | true
babel | any object containing valid Babel optionsNote: does not merge with defaults | {presets: ['@babel/preset-react', [ '@babel/preset-env', {'targets': {'node': 'current'}}]]}
The defaults are sane, but just in case you want to change something, here's how it would look:
var options = { beautify: true };
app.engine('jsx', require('express-react-views').createEngine(options));Views
Under the hood, Babel is used to compile your views to code compatible with your current node version, using the react and env presets by default. Only the files in your views directory (i.e. app.set('views', __dirname + '/views')) will be compiled.
Your views should be node modules that export a React component. Let's assume you have this file in views/index.jsx:
var React = require('react');
class HelloMessage extends React.Component {
render() {
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/layouts/default.jsx:
var React = require('react');
class DefaultLayout extends React.Component {
render() {
return (
<html>
<head><title>{this.props.title}</title></head>
<body>{this.props.children}</body>
</html>
);
}
}
module.exports = DefaultLayout;views/index.jsx:
var React = require('react');
var DefaultLayout = require('./layouts/default');
class HelloMessage extends React.Component {
render() {
return (
<DefaultLayout title={this.props.title}>
<div>Hello {this.props.name}</div>
</DefaultLayout>
);
}
}
module.exports = HelloMessage;Locals from context
Sometimes, eg. when dealing with layouts, you want to be able to access your template locals from any component in the rendering tree. This fork of the express-react-views module provides that functionality through the LocalsContext export.
You should only use this API if explicitly passing in props would result in an unacceptable amount of boilerplate code. Always prefer explicitly-passed-in props where possible.
The following example uses the Hooks API, but it will work with the older HOC-based approach, too. It's just easier and more readable to express context usage with Hooks.
views/layouts/default.jsx:
const React = require('react');
const expressReactViews = require('express-react-views');
module.exports = function DefaultLayout(props) {
let locals = React.useContext(expressReactViews.LocalsContext);
return (
<html>
<head><title>{locals.title}</title></head>
<body>{props.children}</body>
</html>
);
};views/index.jsx:
const React = require('react');
const DefaultLayout = require('./layouts/default');
module.exports = function HelloMessage(props) {
return (
<DefaultLayout>
<div>Hello {props.name}</div>
</DefaultLayout>
);
};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.
This fork of express-react-views also provides a context-based API, that lets you access template locals directly from within other components in your rendering tree. This brings the API closer to that of other view engines with template-global availability of locals, to reduce the amount of boilerplate necessary to work with eg. layouts.
You should still carefully consider your usage of this API, though; pass locals into components explicitly where possible, and only use the context API if there's no other ergonomic way to accomplish your goal.
Caveats
- I'm saying it again to avoid confusion: this does not do anything with React in the browser. This is only a solution for server-side rendering.
- This currently uses
requireto 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 usedangerouslySetInnerHTML={{__html: 'script content'}}. You can take advantage of ES6 template strings here.
<script dangerouslySetInnerHTML={{__html: `
// Google Analytics
// is a common use
`}} />- It's not possible to specify a doctype in JSX. You can override the default HTML5 doctype in the options.
Contributors
- Paul O’Shannessy (Author)
- Venkat Reddy