Skip to content

cft-group/elephas-react

Repository files navigation

npm version Build status

Elephas Design System was created to build consistent user interfaces across different teams and products at Center of Financial Technologies. Our goal is to maintain great developer experience for software engineers, no matter which platform they are building on.

Elephas React is a library that implements Elephas Design System components using React. It has a Storybook documentation describing all available components.

Installation and Usage

  1. Install Elephas React and CSS packages.
# Yarn
yarn add @elephas/core @elephas/layout @elephas/react-core @elephas/react-layout

# npm
npm install @elephas/core @elephas/layout @elephas/react-core @elephas/react-layout
  1. Make sure you have installed peer dependencies.
# Yarn
yarn add react react-dom mime

# npm
npm install react react-dom mime
  1. Add Inter font to your project.

  2. Import CSS in your index.js file.

import '@elephas/layout/styles.min.css';
import '@elephas/core/styles.min.css';
  1. Use components as following:
import React from 'react';
import { Button } from '@elephas/react-core';

function MyComponent() {
  return (
    <Button appearance="primary">Click Me</Button>
  );
}

License

Source code is under a custom license based on MIT. The license restricts Elephas usage to applications that integrate or interoperate with Center of Financial Technologies software or services, with additional restrictions for external, stand-alone applications.