Spectrum

Welcome to the UI components library for cloud app and related micro-frontend apps like engage, channels etc. This repository promotes code de-duplication by consolidating all the reusable UI components used by these apps.

Developing guide

📚 What is this repository for?

• This repository contains reusable UI components that can shared across multiple micro-frontend apps.

📦 What does this repository contain?

• src: This directory contains all the UI components code and resources.

🔧 How can I use this package?

To use the UI components provided by this library in your app, follow these steps:

1. Install the package:

   npm install @yellow/spectrum

2. Import @yellow/spectrum/lib/spectrum.css in your app's global entry point

3. Import the desired UI component from the library in your app's code:

For exmaple:

import { YAButton, YACheckbox } from "@yellow/spectrum";

To access types, use

import { TypographyProps } from "@yellow/spectrum/lib/types";

4. Use the imported components in your app's code as needed.

📞 Who do I talk to?

If you have any questions or need assistance, please reach out to the UI Team.

📅 Future plans?

We have exciting plans for the future, including:

• Moving most of the UI components that can shared across multiple micro-frontend apps.
• Maintaining detailed release notes to keep track of changes and improvements.
• Unit tests