@mycrypto/ui

The shared UI component library used across all MyCrypto products.

Usage no npm install needed!

<script type="module">
  import mycryptoUi from 'https://cdn.skypack.dev/@mycrypto/ui';
</script>

README

MyCrypto UI

Build Status Codecov

The shared UI component library used across all MyCrypto products.

Implemented with React components following Atomic Design.

Installation

Requires a bundler with ES module support.

yarn add @mycrypto/ui styled-components

Wrap your app in a ThemeProvider to use the included theme.

import { Body, theme } from '@mycrypto/ui';
import { ThemeProvider } from 'styled-components';

<ThemeProvider theme={theme}>
  <Body>Hello, world!</Body>
</ThemeProvider>;

Typeface

Our designs use the Lato and Roboto Mono typefaces, which you will probably need to install in your app or site. There are several options depending on your requirements and build tooling:

Development

You can launch the storybook simply by running yarn start. To test changes inside other projects directly, you can use yarn link:

# Inside the UI folder
yarn link
yarn build

# Inside your own project
yarn link @mycrypto/ui

Deployment

The npm package is automatically updated by GitHub CI whenever the version is changed inside package.json.