@compassion-design-system/react-native
TypeScript icon, indicating that this package has built-in type declarations

2.0.0-alpha.10 • Public • Published

@compassion-design-system/react-native

React Native components and patterns of the Compassion Design System.

Installation

npm install @compassion-design-system/react-native

Usage

Components:

import { Button } from '@compassion-design-system/react-native';

// export interface ButtonProps {
//  label: string;
//  kind?: 'default' | 'cta' | 'white' | 'inverted' | 'destructive';
//  emphasis?: 'primary' | 'secondary' | 'tertiary';
//  disabled?: boolean;
//  size?: 'small' | 'medium' | 'large';
//  onPress?: (event: GestureResponderEvent) => void;
// }

// React button documentation -  https://designwithcompassion.com/storybook/react/?path=/docs/components-button--docs

<Button label="Default" />
<Button label="CTA" kind="cta" />
<Button label="White" kind="white" emphasis="secondary" />
import { Badge } from '@compassion-design-system/react-native';

// ...

<Badge label="Primary" status="primary" />
<Badge label="Primary Pill" status="primary" borderRadius="pill" />
<Badge label="Warning" status="warning" />
<Badge label="Danger" status="danger" />
<Badge label="Success" status="success" />
<Badge label="Info" status="info" />
<Badge label="Neutral" status="neutral" />

Stylesheet values:

import { StyleSheet } from 'react-native';
import { cdsLightTokens } from '@compassion-design-system/react-native';

// ...

const styles = StyleSheet.create({
  card: {
    backgroundColor: cdsLightTokens.cardBackgroundColor,
    borderColor: cdsLightTokens.cardBorderColor,
    borderWidth: cdsLightTokens.cardBorderWidth,
    borderRadius: cdsLightTokens.cardBorderRadius,
  },
  cardHeader: {
    ...cdsLightTokens.cardHeaderDefault,
    color: cdsLightTokens.cardHeaderColor,
  },
});

Development

This project uses a monorepo using yarn. To setup the project, run yarn in the root directory to install the required dependencies.

yarn

The monorepo includes an example app that consumes @compassion-design-system/react-native. Run the app to test out components and exported modules from the library. You will need to install an emulator (https://developer.android.com/studio) to view the app locally.

yarn example android

License

MIT


Made with create-react-native-library

Package Sidebar

Install

npm i @compassion-design-system/react-native

Weekly Downloads

0

Version

2.0.0-alpha.10

License

MIT

Unpacked Size

2.13 MB

Total Files

98

Last publish

Collaborators

  • redavis
  • jhur
  • kendrick.