react-via-cep
v2.0.8
simple integration for https://viacep.com.br
0/weekUpdated 3 years agoMITUnpacked: 521.3 KB
Published by Arthur Ribeiro
npm install react-via-cepreact-via-cep
=======
integração simples para https://viacep.com.br
Instalação
Instalar via npm:
``
npm i --save react-via-cep
Instalar via yarn:
yarn add react-via-cep
Docs
Component API.
| Nome | Tipo | Padrão | Descriçãos |
|------------|-----------|---------|-----------------------------------------------------------------------------------------------------|
| cep | String | | Formato do cep 00000-000 ou 00000000 |
| onSuccess | function | | Função executada caso o cep seja encontrado que recebe como paramento um objeto com os dados do cep |
| lazy | Boolean | false | Aguardar a função fetch ser disparada para carregar os dados. Nesse caso o cep deve ser válido |
Exemplo de uso simples.
jsx
import ViaCep from 'react-via-cep';
{ ({ data, loading, error, fetch }) => {
if (loading) {
return loading...
}
if (error) {
return error
}
if (data) {
return
CEP: {data.cep}
CIDADE: {data.localidade}
UF: {data.uf}
}
return
}}
`
Dados retornados
{
"cep": "01001-000",
"logradouro": "Praça da Sé",
"complemento": "lado ímpar",
"bairro": "Sé",
"localidade": "São Paulo",
"uf": "SP",
"unidade": "",
"ibge": "3550308",
"gia": "1004"
}
License
MIT © Arthur Ribeiro