Render React components in Ember
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
addon
blueprints
config
lib
tests
types/dummy
vendor
.editorconfig
.ember-cli
.eslintignore
.eslintrc.js
.gitignore
.lintstagedrc
.npmignore
.prettierrc
.travis.yml
.watchmanconfig
CHANGELOG.md
LICENSE.md
README.md
commitlint.config.js
ember-cli-build.js
index.js
package.json
testem.js
tsconfig.json
yarn.lock

README.md

ember-react-components

Build Status

Consume React components in Ember

This addon is a proof-of-concept for an approach to rendering React components in Ember. It is almost entirely inspired by a blog post by Sivakumar Kailasam, from which the general idea was borrowed.

Installation

ember install ember-react-components

Compatibility

This addon requires Ember CLI 2.15 or higher.

Usage

This addon provides an ES6 class decorator that allows a React element to be rendered in Ember.

As an example, you can create a component like this:

// app/components/my-react-component.js
import React from 'react';
import WithEmberSupport from 'ember-react-components';

@WithEmberSupport
export default class extends React.Component {
  render() {
    const { name } = this.props;

    return (
      <p>Hello, {name}</p>
    );
  }
}

And render it like this:

{{my-react-component name='Alex'}}

That would create a component that renders Hello, Alex.

Options

  • outputFile option imports react and react-dom into a separate file than /assets/vendor.js. This is useful if your entire Ember application doesn't require react. The separate file containing react and react-dom can be imported via a template or initializer.
// ember-cli-build.js
let app = new EmberApp(defaults, {
  'ember-react-components': {
    outputFile: '/assets/react.js'
  }
});

What all is this addon doing?

  • Provides imports for react and react-dom
  • Hooks up a bunch of necessary babel transforms
  • Provides a decorator for creating a thin wrapper around your React components that bridge the gap between the two libraries

Is this production ready?

It does work, but you should be really careful about including both the Ember and React libraries in your application since that's quite a lot of JavaScript to ship to your users.

License

This project is licensed under the MIT License.