React Compass

This project provides a set of components for the React Compass Design System that can be used to implement user experiences consistent with ComfortDelGro's design principles.

Getting started

React

Installation

To get started, run

yarn add @comfortdelgro/react-compass

or

npm install @comfortdelgro/react-compass

or

pnpm install @comfortdelgro/react-compass

Make sure you have all the required peer dependencies installed in the first place.

Usage

import {Button} from '@comfortdelgro/react-compass'
;() => <Button variant='primary'>Click Me</Button>

or

import Button from '@comfortdelgro/react-compass/button'
;() => <Button variant='primary'>Click Me</Button>

Reporting a Bug

If you spot a bug, inconsistency, or typo, please open a bug issue. Better yet, submit a pull request to address it.

Feature Requests

If you have an idea, we would love to hear about it. The best way to suggest a feature is to open a feature issue.

License

MIT © 2022