README.md

Comic Relief React Component Library

React components to be shared across Comic Relief applications

Use

CR-CL has a dependency of Styled-components.

Install the package

$ yarn add @comicrelief/component-library

Wrap your app with the ThemeProvider and crTheme

import { ThemeProvider, crTheme } from '@comicrelief/component-library';

Import components

import { HeroBanner } from '@comicrelief/component-library';

Develop

To install CR-CL locally, run:

$ yarn install

To start the dev build and server:

$ yarn styleguide

To test:

$ yarn test:unit

Test will run through all Jest tests and watch for any changes on snapshots.

To update snapshots with desired changes brought in through your work:

$ yarn test:unit-update

To publish

$ yarn publish:npm