vue-brazil
v0.2.1
Published
Commons and utils in vue for brazillian apps
Downloads
266
Readme
vue-brazil
Commons and utils in vue for brazillian apps
Javascript Validate, Mask, Faker e Utils para Tipos do Brasil: Celular, CEP, Certidão, CNH, CNPJ, CNS, CPF, Currency, Date, ECT, EMAIL, Empresa, Endereço, Inscrição Estadual, Number, Percentage, Pessoa, PIS/PASEP, placa (Placa de carro), processo (Processo da justiça), RENAVAM , RG , Site, Telefone , Time (data/hora), Título de Eleitor , Veículo
Live example:
- https://stackblitz.com/edit/vue-brazil
See the demo working project in sampleapp folder.:
Installation
To install this library with npm, run:
npm install --save vue-brazil js-brasil
Usage
Configuration
Import module in root
import Vue from 'vue'
import App from './App'
import VueBrazil from 'vue-brazil'
Vue.use(VueBrazil)
new Vue({
el: '#app',
router,
components: { App },
template: '<App/>'
})
Tipos
Os tipos disponiveis para filtros, masks a validação são:
aih, cartaocredito, celular, cep, certidao, chassi, ci cnae, cnh, cnpj, cns, contabanco, cpf, cpfcnpj, currency, data, ect, endereco, inscricaoestadual iptu, number, porcentagem pispasep, placa, processo, renavam, rg, sped, telefone time, titulo, utils
Vejam todos e updates em JSBrasil
Filters / Masks / Forms / Validation
Filters : Para usar um filtro faça {{ valor | vueBrazil(tipo) }}
Mask : Para usar mask use <input v-brazilmask="{ type: 'cpf' }" />
Validation : Para validação, marque o input como data-brtype <input v-brazilmask="{ type: 'cpf' }" data-brtype="cpf" id="cpf" name="cpf" />
, depois use no método checkForm JSBrazilValidate(e, this.errors)
Veja um exemplo completo:
<template>
<div class="hello">
<form @submit="checkForm" action="#/" method="post">
CPF: {{ cpf | vueBrazil('cpf') }}
<!-- será exibido 123.456.789.01 --->
<input v-brazilmask="{ type: 'cpf' }" data-brtype="cpf" id="cpf" name="cpf" />
<!-- criará uma máscara no input exibindo 123.___.___.__ --->
<p v-if="errors.length">
<b>Please correct the following error(s):</b>
<ul>
<li v-bind:key="error" v-for="error in errors">{{ error }}</li>
</ul>
<!-- exibirá um erro `cpf inválido` , o nome `cpf` ele pegará do id ou name do input --->
</p>
<button>Submit</button>
</div>
</template>
<script>
import { JSBrazilValidate } from 'vue-brazil'
export default {
name: 'Vue-Brazil',
methods: {
checkForm: function (e) {
this.errors = []
// Put your own logic here
// if(!wrong){
// this.errors.push('Name required.')
// }
// Get the JsBrasil validations
JSBrazilValidate(e, this.errors)
e.preventDefault()
}
},
data () {
return {
cpf: '12345678901',
errors: []
}
}
}
</script>
Demo
Demo component files are included in Git Project.
Demo Project: https://github.com/mariohmol/vue-brazil/tree/master/sampleapp/src/components
Reference projects:
- https://github.com/mariohmol/js-brasil
TODO
Tem várias issues para trabalha e ajudar no projeto.
Contribute
Ajude também! Fork o projeto e siga os passos abaixo para montar o ambiente.
Instale o yarn:
curl -o- -L https://yarnpkg.com/install.sh | bash
Instale o vuejs
yarn global add @vue/cli-init
npm install --global @vue/cli
Fork esse repositório, clone em sua máquina e instale as dependencias, na pasta raiz e na sampleapp:
npm i
cd sampleapp
npm i
Para iniciar o processo de desenvolvimento:
npm run start
Para publicar nova versão,é necessárioincrementara versao no package e rodar
npm run publishnpm
License
MIT(./LICENSE)