README.md

Gerador e Validador de CPF

Biblioteca JS open-source para gerar, validar e formatar CPF.

A ferramenta pode ser acessada pelo link: http://tiagoporto.github.io/gerador-validador-cpf/.

Índice

• Uso
  • Gerando CPF
  • Validando CPF
  • Formatando CPF
• Contribuição
• Licença

Uso

Faça o download com NPM.

$ npm install gerador-validador-cpf --save

ou com Bower.

$ bower install gerador-validador-cpf --save

• Inclua o arquivo no rodapé da sua página, como no exemplo.

<script src="node_modules/dist/js/CPF.js"></script>

Gerando CPF

Para gerar CPF basta chamar a função generate(), veja um exemplo:

CPF.generate();

Exemplo completo de uma possível utilização.

document.getElementById('btn-gerar-CPF').onclick = function(){
    document.getElementById('CPF').innerHTML = CPF.generate();
};

Exemplo de validação utilizando um método com vuejs.

import cpf from 'gerador-validador-cpf';

new Vue({
    el: '#app',
    
    methods: {
        validar_seu_cpf(value) {
            return cpf.validate(value);
        }
});

A função recebe como parâmetro opcional a formatação do CPF, opções.

Validando CPF

Para validar um CPF basta chamar a função validate(cpf), passando como parâmetro o número a ser validado, não se preocupe com os caracteres ., - e espaço, a função fica encarregada de eliminar esses caracteres para verificação posterior, veja um exemplo:

CPF.validate("123.456.789-00");

Exemplo completo de uma possível utilização com tratamento da mensagem de erro.

document.getElementById('valida-CPF').onsubmit = function (event){
    document.getElementById('resultadoValidacao').innerHTML = CPF.validate(document.getElementById('cpf').value);

    return false;
};

Formatando CPF

Para formatar um CPF basta chamar a função format(cpf, param), passando como parâmetro o CPF a ser formatado, não se preocupe com os caracteres ., - e espaço, a função fica encarregada de eliminar esses caracteres para verificação posterior, veja um exemplo:

CPF.format("123.456.789-00");

Exemplo completo de uma possível utilização.

document.getElementById('CPF').onblur = function (){
    document.getElementById('CPF').value = CPF.format(document.getElementById('CPF').value);
};

Opções de formatação

Padrão

CPF.format('12345678901');

Gera um CPF no formato xxx.xxx.xxx-xx

Dígitos

CPF.format('123.456.789-01', 'digits');

Gera um CPF no formato xxxxxxxxxxx

Verificador

CPF.format('12345678901', 'checker');

Gera um CPF no formato xxxxxxxxx-xx

Contribuição

Veja como contribuir.

Licença

Gerador e validador de CPF está sobre os termos da licença MIT.