Optimal Compliance React Component Library

React component library used in Optimal Compliance React projects

Installation

Use npm to install.

npm install @oc-digital/react-component-library

or yarn

yarn add @oc-digital/react-component-library

Peer dependencies

  "react": ">=17.0.0",
  "react-dom": ">=17.0.0",
  "react-router-dom": ">=6.0.0",
  "@date-io/date-fns": "=1.3.13",
  "date-fns": "=2.25.0",
  "react-number-format": "=4.8.0",
  "yup": "=0.32.11",
  "react-table": "=7.7.0",
  "lodash": "^4.17.21",

Usage

import React from "react";
import { Button } from "@oc-digital/react-component-library";

const ReactComponent = () => (
  <Button onClick={() => console.log("Clicked me!")}>Click Me!</Button>
);

Local Development

1. In your downstream app, run npm install ../react-component-library (use the path to react-component-library directory)
2. Start your downstream app in watch mode (for Partners this is just npm start)
3. In here, run npm run build:watch
4. Profit

Remember to change back the package.json once you're done.

Deploying to dev

1. increment the package version and add -beta.0 (e.g. 2.0.6 => 2.0.7-beta.0) and run npm install 1a. if you need to further increment and publish use -beta.1, -beta.2 and so on 1b. you can use this all in one command for the above - npm version 2.0.7-beta.0
2. publish the component library with command - npm run beta
3. pin the version in the receiving library to "=2.0.7-beta.0" and run npm install
4. once happy with the changes remove -beta.0 part and part and publish component library 4a. update the version in the receiving library to "^2.0.7"

Publishing a new version with npm commands

1. run npm version minor(patch|major)
2. git push origin vX.Y.Z

Publishing a new version manually

1. Update the version in package.json
2. Create and push a git tag:

   git tag v1.2.3
   git push origin v1.2.3

The package will be automatically published to npm via GitHub Actions.

Playground

Use storybook to explore components

npm run storybook