@comicrelief/component-library

Comic Relief React Component Library --------------

Usage no npm install needed!

<script type="module">
  import comicreliefComponentLibrary from 'https://cdn.skypack.dev/@comicrelief/component-library';
</script>

README

Comic Relief React Component Library

CircleCI semantic-release

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 '@comic-relief/component-library';

Import components

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

Develop

To install CR-CL locally run

$ yarn install

To start

$ yarn styleguide

To test

$ yarn test

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

To update snapshots

$ yarn test -u

To publish

$ yarn publish:npm