README.md

Quantum is a react component library that dictates Catho Frontend applications.

Warning Quantum requires react@16.14.0 or higher.

Notices ⚠️

For performance and long-term maintenance reasons, we do not recommend using MUI in Quantum components implementation. MUI is present in our library only to allow the use of Material Icons.

Also, we do not recommend using any other ready-made component library. We suggest for new components to have DOM structure, styling and functionalities completely implemented internally, without any dependence on third-party libraries.

For more details, visit the "Important notices" section at CONTRIBUTING.MD

Getting started

Quantum is available as an npm package. It can be installed using:

yarn add @catho/quantum styled-components
# or npm install @catho/quantum styled-components

In order to use a component, it need to be imported in your project as follow:

import { Button } from '@catho/quantum';
// or import Button from '@catho/quantum/Button';

The list of all components and their documentation can be found at our storybook

Contributing

• Check the issues to ensure that there is not someone already working on it.
• Check our contribution guide.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Daniel Silva 📖 💻 🤔 👀 ⚠️	Gabriel Daltoso 📖 💻 🤔 👀 ⚠️	Allysson dos Santos 💻 👀 📖 ⚠️ 🤔	Alan Oliveira 💻 👀 📖 ⚠️ 🤔	Raphael Oliveira 💻 👀 📖 ⚠️ 🤔	Renato Galvão 📖 💻 🤔 👀 ⚠️
Pedro Morais 📖 💻 🤔 👀 ⚠️	Rodrigo Clemente 📖 💻 🤔 👀 ⚠️	Tiago Celestino 💻 🤔 👀 ⚠️	Luiz Jacção 💻 👀	Alisson Suzigan 💻 🤔 👀 ⚠️	Ton Cabral 💻 📖 🤔 👀 ⚠️
Matheus Rodrigues 💻 📖 🤔 👀 ⚠️

This project follows the all-contributors specification.
Contributions of any kind welcome!