Skip to content
Neutrino preset that supports building React applications in TypeScript.
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples chore: clean configuration Apr 12, 2017
test initial commit Apr 6, 2017
.editorconfig initial commit Apr 6, 2017
.gitignore feat: add examples Apr 11, 2017
.travis.yml
CHANGELOG.md chore(release): 0.5.0 Apr 18, 2017
LICENSE initial commit Apr 6, 2017
README.md chore(readme): split example in two code blocks Apr 24, 2017
index.js build: update neutrino to v8 Dec 21, 2018
package.json build: update neutrino to v8 Dec 21, 2018
yarn.lock chore: clean configuration Apr 12, 2017

README.md

Neutrino TypeScript React Preset

Build Status npm version

Requirements

  • Node.js v6.9+
  • Yarn or npm client
  • Neutrino v5

Installation

neutrino-preset-typescript-react can be installed via the Yarn or npm clients. Inside your project, make sure neutrino and neutrino-preset-typescript-react are development dependencies, and that react, and react-dom along with their type definitions @types/react, @types/react-dom are dependencies.

Yarn

❯ yarn add --dev neutrino neutrino-preset-typescript-react
❯ yarn add react react-dom @types/react @types/react-dom

npm

❯ npm install --save-dev neutrino neutrino-preset-typescript-react
❯ npm install --save react react-dom @types/react @types/react-dom

Project Layout

neutrino-preset-typescript-react follows the standard project layout specified by Neutrino. This means that by default all project source code should live in a directory named src in the root of the project. This includes JavaScript files, CSS stylesheets, images, and any other assets that would be available to your compiled project.

Quickstart

After installing Neutrino and the typescript react preset, add a new directory named src in the root of the project, with a single TypeScript file named index.ts in it.

❯ mkdir src && touch src/index.ts && touch src/Hello.tsx

This preset exposes an element in the page with an ID of root to which you can mount your application. Edit your src/index.ts file with the following:

// src/index.ts
import * as React from "react";
import * as ReactDOM from "react-dom";

import { Hello } from './Hello';

ReactDOM.render(
  React.createElement(Hello, { compiler: 'TypeScript', framework: 'React' }),
  document.getElementById('root')
);
// src/Hello.tsx
import * as React from "react";

export interface HelloProps {
  compiler: string;
  framework: string;
}

export const Hello = (props: HelloProps) => (
  <div>
    <h1>Hello from {props.compiler} and {props.framework}!</h1>
    <p>Hello world</p>
  </div>
);

Now edit your project's package.json to add commands for starting and building the application:

{
  "scripts": {
    "start": "neutrino start --use neutrino-preset-typescript-react",
    "build": "neutrino build --use neutrino-preset-typescript-react"
  }
}

Start the app, then open a browser to the address in the console:

Yarn

❯ yarn start
✔ Development server running on: http://localhost:5000
[at-loader] Using typescript from typescript and "tsconfig.json" from tsconfig.json.
⠇ Waiting for initial build to finish
[at-loader] Checking started in a separate process...
[at-loader] Ok, 0.128 sec.
✔ Build completed

npm

❯ npm start
✔ Development server running on: http://localhost:5000
[at-loader] Using typescript from typescript and "tsconfig.json" from tsconfig.json.
⠇ Waiting for initial build to finish
[at-loader] Checking started in a separate process...
[at-loader] Ok, 0.128 sec.
✔ Build completed

Hot Module Reloading

Add react-hot-loader@next as a dependency, and its typing @types/react-hot-loader

❯ yarn add react-hot-loader@next @types/react-hot-loader

Wrap your application with react-hot-loader AppContainer component, preferrably you should do this at the root of your project. You will have to listen for changes and re-render the new component in the DOM, like so:

// src/index.ts
import * as React from 'react';
import * as ReactDOM from 'react-dom';
import { AppContainer } from 'react-hot-loader';

import * as Hello from './Hello';

const load = (Root: any) => {
  const app = React.createElement(Root, { compiler: 'TypeScript', framework: 'React' });
  ReactDOM.render(React.createElement(AppContainer, null, app), document.getElementById('root'));
};

if (module.hot) {
  module.hot.accept('./Hello', () => {
    const NextHello = require('./Hello') as typeof Hello;
    load(NextHello.Hello);
  });
}

load(Hello.Hello);

Take a look at examples/hmr/ for an example on HMR.

You can’t perform that action at this time.