React UI
React UI component library for use at Pattern.
Getting started
The package can be found at @patterninc/react-ui.
The project is setup to run using Yarn. You can install all dependencies by running yarn
.
To run the example app:
yarn start
Developing components and seeing them in Predict/Shelf
yalc publish
in this repoyalc link @patterninc/react-ui
in shelf/predict
then, when you update the styleguide and want to see it in shelf/predict:
yarn yalc-push
in this repo
Note: you can either install yalc
globally, or prefix all the previous commands with npx, e.g. npx yalc publish
Build the library
To build the module to build, so the updated version can be used by other applications:
yarn build
Contents
The build makes the following available:
dist/react-ui.js
dist/styles.css
The JavaScript file contains no styles at all. You'll need to import both to get the look and feel. The following packages are peer dependencies to the library:
- moment
- react
- react-dom
- react-router-dom