https://github.com/catho/quantum

The default pack of components and layout principles that dictates Catho Frontend applications.
https://github.com/catho/quantum

catho react storybook styled-components styleguide

Last synced: 9 months ago
JSON representation

The default pack of components and layout principles that dictates Catho Frontend applications.

• Host: GitHub
• URL: https://github.com/catho/quantum
• Owner: catho
• License: gpl-3.0
• Created: 2019-01-08T10:04:56.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-04-22T13:03:56.000Z (over 1 year ago)
• Last Synced: 2024-04-22T13:08:22.445Z (over 1 year ago)
• Topics: catho, react, storybook, styled-components, styleguide
• Language: JavaScript
• Homepage: https://catho.github.io/quantum
• Size: 47 MB
• Stars: 58
• Watchers: 12
• Forks: 17
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.MD
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Quantum CI - publish](https://github.com/catho/quantum/actions/workflows/actions-publish.yml/badge.svg)](https://github.com/catho/quantum/actions/workflows/actions-publish.yml)

[![npm version](https://badge.fury.io/js/%40catho%2Fquantum.svg)](https://badge.fury.io/js/%40catho%2Fquantum)

[![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)



  



**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](https://mui.com/material-ui/getting-started/) in Quantum components implementation. MUI is present in our library only to allow the use of [Material Icons](https://mui.com/material-ui/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](https://github.com/catho/quantum/blob/master/CONTRIBUTING.MD#important-notices)

## Getting started

Quantum is available as an [npm package](https://github.com/catho/quantum/pkgs/npm/quantum). It can be installed using:

```sh

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:

```jsx

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**](https://catho.github.io/quantum/)

## Contributing

- Check the [issues](https://github.com/catho/quantum/issues) to ensure that there is not someone already working on it.

- Check our [contribution guide](https://github.com/catho/quantum/blob/master/CONTRIBUTING.MD).

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/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](https://github.com/all-contributors/all-contributors) specification.


Contributions of any kind welcome!