@getsoren/design-system

A design system React library

The library is based on MUI Core

• Installation
• Usage
  • Provide the theme
• Package
• Docs
• Contributing

Installation

npm:

npm install @getsoren/design-system

bun:

bun add @getsoren/design-system

yarn:

yarn add @getsoren/design-system

pnpm:

pnpm add @getsoren/design-system

Usage

Provide the theme

Put <ThemeProvider> around your application. Custom theme can be provided as prop theme={YOUR_CUSTOM_THEME}

import { Button, ThemeProvider } from "@getsoren/design-system";

const App = () => (
  <ThemeProvider>
    <Button>Text</Button>
  </ThemeProvider>
);

export default App;

Package

Package are available in @getsoren/design-system/{package}

| Package | Description | |---------|-----------------------------------------------| | colors | This package contains material design colors. |

Docs

• Material UI (MUI)
• Figma
• Storybook

Contributing

Read the contributing guide to learn about our process.