tps-design-system

Library of React UI components for tenancy.co.nz apps.

Usage no npm install needed!

<script type="module">
  import tpsDesignSystem from 'https://cdn.skypack.dev/tps-design-system';
</script>

README

Tenancy Design System

A collection of UI components built with React ⚛️

🛠️ Tech stack

Building components

⚛️ React declarative component-centric UI
💅 Styled-components for component-scoped styling
📚 Storybook for UI component development

🚀 Getting started

To install @tenancy.nz/design-system in your project, you will need to run the following command using npm:

npm install @tenancy.nz/design-system

If you prefer Yarn, use the following command instead:

yarn add @tenancy.nz/design-system

🧱 Usage

import {Button} from '@tenancy.nz/design-system';

function Component() {
  return <Button>Example usage</Button>;
}

For more information about each component, check out our Storybook.

📚 Documentation

Storybook