sc-ui-component-library
SC UI Component Library
A collection of reusable React components built with Material-UI, designed for consistent and efficient UI development.
Overview
This library provides a set of pre-built, customizable React components that follow Material Design principles. It's built on top of Material-UI and includes additional styling and functionality specific to our needs.
Installation
This library requires several peer dependencies to be installed in your project. You can install the library and its required dependencies using one of the following methods:
Using Yarn
yarn add sc-ui-component-library @emotion/react @emotion/styled @mui/material @mui/icons-material @fontsource/roboto
Using npm
npm install sc-ui-component-library @emotion/react @emotion/styled @mui/material @mui/icons-material @fontsource/roboto
Required Peer Dependencies
The following dependencies are required to be installed in your project:
| Package | Version |
|---|---|
| @emotion/react | ^11.0.0 |
| @emotion/styled | ^11.0.0 |
| @mui/material | ^5.0.0 |
| @mui/icons-material | ^5.15.10 |
| @fontsource/roboto | ^5.2.5 |
| react | 17.0.2 or ^18.3.1 |
| react-dom | 17.0.2 or ^18.3.1 |
Important Notes
- These dependencies are marked as peer dependencies to avoid version conflicts and duplicate installations
- You must install these dependencies in your project for the components to work properly
- If you're already using Material-UI in your project, you can skip installing the MUI packages if your versions are compatible
Versioning
This project follows Semantic Versioning. For the versions available, see the tags on this repository.
License
This project is licensed under the UNLICENSED License - see the LICENSE file for details.