README.md

Arbor

Arbor is a set of React UI components for Catch&Release's design system. It is built using emotion and styled-system.

Getting Started

Installation

Install the Arbor package and its dependencies.

npm install --save @catchandrelease/arbor

or

yarn add @catchandrelease/arbor

Usage

import React from 'react';
import { render } from 'react-dom';
import { Heading, theme } from '@catchandrelease/arbor';
import { ThemeProvider } from '@emotion/react';

function App() {
  return (
    <ThemeProvider theme={theme}>
      <Heading.H1>Hello World</Heading.H1>
    </ThemeProvider>
  );
}

render(<App />, document.getElementById('app'));

The application must be wrapped in an emotion ThemeProvider in order to work. You can import the base theme from arbor, or customize it and pass in your own. See emotion-theming.

License

The package is available as open source under the terms of the MIT License.