@puppet/react-components NPM

Puppet React Components

Puppet React Components is a collection of general-purpose reusable React components and their associated styles.

Component documentation

Components are documented using React Styleguidist, which provides API docs alongside live editable (in-browser) React components. To view these, clone this repository, install dependencies, and run the Styleguidist server:

git clone git@github.com:puppetlabs/design-system.git && cd design-system/packages/react-components
npm install
npm start
Open http://localhost:6060.

Installation

npm install @puppet/react-components

Setup

Using with webpack (without Create React App)

React Components utilizes Calibre and Open Sans. In order for Calibre to load, you will need to process the react-components scss with Webpack. This has currently been tested with webpack 4 using css-loader, sass-loader, file-loader, resolve-url-loader, and mini-css-extract-plugin. The following is an example configuration for a consuming application:

const common = {
  mode: 'none',
  context: path.join(__dirname, '/source/react'),
  entry: ['./main.js'],
  output: {
    path: path.join(__dirname, '/build'),
    publicPath: '/',
    filename: 'application.js',
  },
  resolve: {
    symlinks: false,
    extensions: ['.js', '.jsx', '.json'],
  },
  module: {
    rules: [
      {
        test: /\.scss$/,
        exclude: /node_modules/,
        use: [
          { loader: MiniCssExtractPlugin.loader },
          { loader: 'css-loader' },
          { loader: 'resolve-url-loader' },
          { loader: 'sass-loader', options: { sourceMap: true } },
        ],
      },
      {
        test: /\.js$/,
        use: 'babel-loader',
      },
      {
        test: /\.(eot|svg|ttf|woff|woff2|png|jpg)$/,
        use: 'file-loader',
      },
    ],
  },
  node: {
    fs: 'empty',
  },
};

Troubleshooting missing fonts and SASS/SCSS compiling errors when using with webpack

If you encounter an error loading fonts, you are most likely not installing the resolve-url-loader package defined in the setup above. A possible error message for this failure could read:

Can't resolve './fonts/OpenSans-SemiboldItalic.woff2' in '/Users/me/Documents/Puppet/relay-website/src/pages'

Likewise, SASS/SCSS compilation errors will arise if css-loader and sass-loader are not declared.

An alternative to `resolve-url-loader` when using with webpack

Import react-components' ui.scss after defining the path to your local sass-variables/fonts file.

pds_styles.scss

// Allow webpack to resolve font URLs relative to this entrypoint
$puppet-common-font-path: './node_modules/@puppet/sass-variables/fonts';

@import '~@puppet/react-components/source/scss/library/ui';

pages/index.js

import '../pds_styles.scss'

...

Using With Gatsby

In addition to needing resolve-url-loader, a Gatsby app will need gatsby-plugin-sass in order to support the SASS/SCSS stylesheets in the design system. First install gatsby-plugin-sass, then configure useResolveUrlLoader. Given this configuration, a Gatsby app will not need css-loader or sass-loader.

Using with Create React App (CRA)

If you are using CRA with react-app-rewired (after following their instructions for switching from react-scripts to react-app-rewired in package.json), you can use this included rewire instead (after adding resolve-url-loader to devDependencies):

// config-overrides.js
const rewireResolveUrlLoader = require('@puppet/react-components/config/rewire-resolve-url-loader.js');
module.exports = function override(config, env) {
  config = rewireResolveUrlLoader(config, env);
  return config;
};

Contributing with CRA

If you want to npm link or yarn link react-components in a CRA app, you may need to disable CRA's ModuleScopePlugin because resolve-url-loader will output an absolute path to the react-components. This can be accomplished with an included rewire:

// config-overrides.js
const rewireRemoveModuleScopePlugin = require('@puppet/react-components/config/rewire-remove-module-scope-plugin.js');
module.exports = function override(config, env) {
  config = rewireRemoveModuleScopePlugin(config, env);
  return config;
};

Using components

The full set of react components are exported from the project root and can be imported as such:

import { Button } from '@puppet/react-components';
const MyComponent = () => <Button>My Button</Button>;

Contributing

Please see our CONTRIBUTING.md for details on setting up your development environment, opening a Pull Request, and requesting reviews.

Additional configuration examples

Continuous Delivery for PE

The following configuration allows CD4PE to rely on react-components to provide all its required fonts.

webpack.config.js
puppetReactComponentsStyles.scss imports all the scss from react-components.
Layout.jsx actually applies this scss to the app.
Building the app generates all the required font files in CD4PE's public folder.