Skip to content
Create generic React components and previewing them without the need to embed in an application. Plays nicely with other Neutrino middleware, so you can build, test, preview, and publish multiple React components from a single repository.
Branch: master
Clone or download
Latest commit 02f6365 Oct 12, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Fixing switching stories May 3, 2017
.gitignore Initial commit Apr 6, 2017
README.md Upgrading to neutrino v6 Jun 20, 2017
index.js Unmerged commit Oct 10, 2017
neutrino-react-components-example.gif Updating README Apr 6, 2017
package.json 3.0.0 Oct 12, 2017
yarn.lock Upgrading to Neutrino v7 Oct 12, 2017

README.md

Neutrino React Components Preset

NPM version NPM downloads Join Slack

neutrino-preset-react-components is a Neutrino preset that supports creating generic React components and previewing them without the need to embed in an application. Plays nicely with other Neutrino middleware, so you can build, test, preview, and publish multiple React components from a single repository.

Features

  • Extends partially from neutrino-preset-react
  • Zero upfront configuration necessary to start developing, building, and visually previewing a React component. Minimal code is needed to generate stories previewer.
  • Modern Babel compilation adding JSX and object rest spread syntax.
  • Support for React Hot Loader
  • Write JSX in .js or .jsx files
  • Support for importing web workers with .worker.js file extensions
  • Extends from neutrino-preset-web
    • Modern Babel compilation supporting ES modules, latest major browser versions, async functions, and dynamic imports
    • Webpack loaders for importing HTML, CSS, images, icons, fonts, and web workers
    • Webpack Dev Server during development
    • Hot module replacement support
    • Easily extensible to customize your project as needed

Important! The Neutrino Web and React presets include babel-polyfill by default, but this preset does not. If you need polyfills in your library code, consider importing babel-polyfill, core-js, or other alternative.

Requirements

  • Node.js v6.10+
  • Yarn or npm client
  • Neutrino v6
  • React, React DOM, and React Addons CSS Transition Group

Installation

neutrino-preset-react-components can be installed via the Yarn or npm clients. Inside your project, make sure neutrino and neutrino-preset-react-components are development dependencies. You will also need React and React DOM for actual component development.

Yarn

❯ yarn add --dev neutrino neutrino-preset-react-components
❯ yarn add react react-dom react-addons-css-transition-group

npm

❯ npm install --save-dev neutrino neutrino-preset-react-components
❯ npm install --save react react-dom react-addons-css-transition-group

If you want to have automatically wired sourcemaps added to your project, add source-map-support:

Yarn

❯ yarn add source-map-support

npm

❯ npm install --save source-map-support

Project Layout

neutrino-preset-react-components 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 that would be available to your compiled project.

All components should be their own module within a directory named components inside the source directory.

Quickstart

After installing Neutrino and this preset, add a new directory named src in the root of the project, with a single JS file named stories.js in it.

❯ mkdir src && touch src/stories.js

Edit your src/stories.js file with the following:

import React from 'react';
import { render } from 'react-dom';
import { Stories, Story, Props } from 'neutrino-preset-react-components/lib';
import YourCustomComponent from './components/YourCustomComponent';

const root = document.getElementById('root');

render((
  <Stories>
    <Story component={YourCustomComponent}>
      <Props name="Default" />
      <Props name="State A" someProp="alpha" />
      <Props name="State B w/ children">Child!</Props>
    </Story>
  </Stories>
), root);

Now edit your project's package.json to add commands for starting the preview app, or building the components.

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

If you are using .neutrinorc.js, add this preset to your use array instead of --use flags:

module.exports = {
  use: ['neutrino-preset-react-components']
};

Start the app, then open a browser to http://localhost:5000 to preview your components:

Yarn

❯ yarn start
✔ Development server running on: http://localhost:5000
✔ Build completed

npm

❯ npm start
✔ Development server running on: http://localhost:5000
✔ Build completed

Building

neutrino-preset-react-components builds components to the lib directory by default when running neutrino build. Using the quick start example above as a reference:

❯ yarn build

✔ Building project completed
Hash: 453804a130a959d313a1
Version: webpack 2.6.1
Time: 350ms
                     Asset     Size  Chunks             Chunk Names
    YourCustomComponent.js  4.12 kB       0  [emitted]  YourCustomComponent
YourCustomComponent.js.map  4.11 kB       0  [emitted]  YourCustomComponent
✨  Done in 3.69s.

You can then publish these components to npm. When publishing your project to npm, consider excluding your src directory by using the files property to whitelist lib, or via .npmignore to blacklist src. Components are generated as UMD named modules, with the name corresponding to the component file name. e.g. src/components/Custom/index.js maps to Custom, as well as src/components/Custom.js mapping to Custom.

These modules are ES-compatible modules, so they can be imported as expected. If you want to use them with CJS require, you'll need to use the .default property to access the default exports:

const YourCustomComponent = require('your-custom-component').default;

By default this preset creates an individual entry point for every top-level component found in src/components.

Previewer Components

This preset exposes 3 React components from neutrino-preset-react-component/lib to generate a component previewer interface:

Stories

The <Stories /> component is the container for how a series of components should be rendered. It is responsible for rendering the navigation menu, switching between components and component states, and rendering the selected component.

The <Stories /> component should be given 1 or more <Story /> components as children.

import React from 'react';
import { render } from 'react-dom';
import { Stories } from 'neutrino-preset-react-component/lib';

const root = document.getElementById('root');

render((
  <Stories>
    ...
  </Stories>
), root);

Story

The <Story /> component defines how a particular component is previewed. It accepts a component property which is the component to preview.

The <Story /> component should be given 1 or more <Props /> components as children which will be used to render the specified component upon selection.

import React from 'react';
import { render } from 'react-dom';
import { Stories, Story } from 'neutrino-preset-react-component/lib';

const root = document.getElementById('root');

class Example extends React.Component {}

render((
  <Stories>
    <Story component={Example}>
      ...
    </Story>
  </Stories>
), root);

Props

The <Props /> component defines what props are passed to the <Story />'s component when this story is selected. All props and children passed to this Props will be passed as props to the component.

The <Props /> component should be given a name property for displaying in the Stories UI.

import React from 'react';
import { render } from 'react-dom';
import { Stories, Story, Props } from 'neutrino-preset-react-component/lib';

const root = document.getElementById('root');

class Example extends React.Component {
  render() {
    return <h1>Hello {this.props.message || 'world'}</h1>;
  }
}

render((
  <Stories>
    <Story component={Example}>
      <Props name="Default" />
      <Props name="With 'Internet'" message="Internet" />
      <Props name="With emphasis" message="WORLD!!!" />
    </Story>
  </Stories>
), root);

example gif

Hot Module Replacement

While neutrino-preset-react-components supports Hot Module Replacement for your app, it does require some changes to the preview app in order to operate. The preview app should define split points for which to accept modules (Components) to reload using module.hot. See the React preset docs for guidance.

Customizing

To override the build configuration, start with the documentation on customization. neutrino-preset-react-components uses a few rules and plugins in addition to the ones in use by the React and Web presets. See the Web documentation customization for preset-specific configuration to override.

By default this preset creates an individual entry point for every top-level component found in src/components.

Rules

The following is a list of rules and their identifiers which can be overridden, in addition to the ones from the Web preset:

Name Description Environments
style Allows importing CSS stylesheets from modules. Contains two loaders named style and css. Allows using CSS modules from project CSS files. all
plain-style Allows importing CSS stylesheets from modules. Contains two loaders named style and css. Used for importing CSS files from node_modules; has CSS modules disabled. all

Plugins

The following is a list of plugins and their identifiers which can be overridden (in addition to the plugins used by the React/Web presets):

Note: Some plugins are only available in certain environments. To override them, they should be modified conditionally.

Name Description Environments
banner Injects source-map-support into the entry point of your application if detected in dependencies or devDependencies of your package.json. all but development

By following the customization guide and knowing the rule, loader, and plugin IDs above, you can override and augment the build by by providing a function to your .neutrinorc.js use array. You can also make these changes from the Neutrino API in custom middleware.

Example: Change the name of the components directory:

module.exports = {
  use: [
    ['neutrino-preset-react-components', {
      components: 'react-stuff' // now you can put your components in src/react-stuff/
    }]
  ]
}
You can’t perform that action at this time.