@comicrelief/component-library

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

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@comicrelief/component-library
2546.4.1a day ago3 years agoMinified + gzip package size for @comicrelief/component-library in KB

Readme

Comic Relief React Component Library

GitHub Actions 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 the dev build and server:
$ yarn styleguide

To test:
$ yarn test
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 -u

To publish
$ yarn publish:npm