https://github.com/clinia/clinia-ui-legacy

React-based design system for healthcare apps.
https://github.com/clinia/clinia-ui-legacy

chakra-ui design-system react uikit

Last synced: 18 days ago
JSON representation

React-based design system for healthcare apps.

• Host: GitHub
• URL: https://github.com/clinia/clinia-ui-legacy
• Owner: clinia
• License: apache-2.0
• Created: 2023-04-06T16:14:31.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-05-16T20:31:41.000Z (over 1 year ago)
• Last Synced: 2024-11-18T14:36:06.221Z (3 months ago)
• Topics: chakra-ui, design-system, react, uikit
• Language: TypeScript
• Homepage: https://clinia-ui-docs.vercel.app
• Size: 742 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Clinia UI Library

## Description

Clinia UI is a modular component library based on Chakra UI.  

It exports various React components as well as a Chakra UI theme.

---

## Library structure

The library is composed of **packages** and a **storybook**.  

Below is a non-exhaustive list of the various packages in the library.

| Package           | Description                                                                                 |

| ----------------- | ------------------------------------------------------------------------------------------- |

| `react`           | Exports basic Chakra UI components as is                                                    |

| `icons`           | Exports Clinia custom icons as single built files (see [Adding icons](#adding-icons))       |

| `theme`           | Chakra UI theme with Clinia colors, fonts, spaces and more                                  |

| Custom components | Various Clinia cutom components (see [Adding custom components](#adding-custom-components)) |

For more information on the storybook package, see the [Storybook](#storybook) section.

---

## Adding custom components

Each custom components should be exported as a separate package under `packages/`.  

If the custom component is an extension of a basic Chakra UI component, the export for the Chakra UI component should be removed from the `react` package.

---

## Adding icons

Each icon added to the `icons/` package should follow these guidelines:

- Chakra UI [guidelines](https://chakra-ui.com/docs/components/icon#creating-your-custom-icons)

- 1024 x 1024 baseline in svg

---

## Storybook

The storybook configuration for the Clinia UI library is under `docs`.

It should have stories for the elements exported in the `packages`, which should be styled according to the `theme` package.

## Code owners

- [mariloufarmer](https://github.com/mariloufarmer)

- [xWiiLLz](https://github.com/xWiiLLz)