react-qrcode-pix/readme.md

Objetivo deste pacote é a de facilitar o recebimento de pagamentos com PIX em aplicações React

# React QRcode PIX

[![npm](https://img.shields.io/npm/v/react-qrcode-pix.svg)](https://www.npmjs.com/package/react-qrcode-pix/v/latest)

[![downloads](https://img.shields.io/npm/dt/react-qrcode-pix)](https://www.npmjs.com/package/react-qrcode-pix/)

[![Tests](https://github.com/guilhermeasn/react-qrcode-pix/actions/workflows/node_tests.yml/badge.svg)](https://github.com/guilhermeasn/react-qrcode-pix/actions/workflows/node_tests.yml)

[![example](https://github.com/guilhermeasn/react-qrcode-pix/actions/workflows/pages/pages-build-deployment/badge.svg)](https://guilhermeasn.github.io/react-qrcode-pix/)

Objetivo deste pacote é a de facilitar o recebimento de pagamentos com PIX em aplicações React. Gerando o Qrcode estático para pagamento.

O *payload* do qrcode foi desenvolvido seguindo os documentos oficiais do BACEN:

 - [ManualBRCode.pdf](https://www.bcb.gov.br/content/estabilidadefinanceira/spb_docs/ManualBRCode.pdf)
 * [II_ManualdePadroesparaIniciacaodoPix.pdf](https://www.bcb.gov.br/content/estabilidadefinanceira/pix/Regulamento_Pix/II_ManualdePadroesparaIniciacaodoPix.pdf)

## 🚀 Instalação

Para instalar no seu projeto React com NPM utilize o comando abaixo:

```
npm install react-qrcode-pix
```

Ou instale com Yarn:

```
yarn add react-qrcode-pix
```

## 🛠️ Configuração

### Propiedade do componente PIX:

 - **pixkey**  ```<string>```: Chave PIX (obrigatório).
 - **merchant**  ```<string>```: Nome do recebedor (obrigatório).
 - **city**  ```<string>```: Cidade do recebedor (obrigatório).
 - **cep**  ```<string>```: CEP do recebedor (opcional).
 - **code**  ```<string>```: Código único para identificação do pagamento (opcional).
 - **amount**  ```<number>```: Valor da transação (opcional).
 - **onLoad** ```<function>```: Callback para receber o payload (opcional).
 - **ignoreErrors** ```<boolean>```: Para não validar as informações (opcional).

*Veja as propriedades relacionadas ao qrcode [aqui](https://github.com/guilhermeasn/react-qrcode-pretty#qrcode-props).*

### Formatos válidos de chave PIX (pixkey):

 - **EMAIL**: fulano_da_silva.recebedor@example.com
 - **CPF**: 12345678900
 - **CNPJ**: 00038166000105
 - **TELEFONE**: +5561912345678
 - **ALEATORIA**: 123e4567-e12b-12d1-a456-426655440000

## 🛠️ Exemplos de Uso

Você pode ver os exemplos em funcionamento [clicando aqui](https://guilhermeasn.github.io/react-qrcode-pix/) ou veja em [sandbox](https://codesandbox.io/s/cool-resonance-rrcv9q?file=/src/App.js).

 - Configuração mínima, sem valor definido:
  
```JS
    <PixCanvas
        pixkey='guilhermeasn@yahoo.com.br'
        merchant='Guilherme Neves'
        city='Paraíba do Sul'
    />
```

 - Configuração completa:
  
```JS
    <PixCanvas
        pixkey='guilhermeasn@yahoo.com.br'
        merchant='Guilherme Neves'
        city='Paraíba do Sul'
        cep='25.850-000'
        code={ 'RQP' + now }
        amount={ 100 }

        onLoad={ payload => setViewPIX(payload) }
    />
```

### Resultado

- QRcode:
  
![QrCodePIX](./qrcode-pix.png)

- Payload:

```
00020126470014BR.GOV.BCB.PIX0125guilhermeasn@yahoo.com.br5204000053039865802BR5915Guilherme Neves6014Paraiba do Sul62070503***6304D1F3
```

## ✒️ Autor

* **Guilherme Neves** - [repositórios github](https://github.com/guilhermeasn/) - [website](https://gn.dev.br)

## 📄 Licença

Este projeto está sob a licença MIT - veja o arquivo [LICENSE](https://github.com/guilhermeasn/react-qrcode-pix/blob/master/LICENSE) para detalhes.