1.0.5 • Published 6 years ago

meta-cpf v1.0.5

Weekly downloads
20
License
-
Repository
-
Last release
6 years ago

meta-cpf

pipeline status coverage report

Input component type boolean based on a checkbox to be used within forms. It contains all required validations.

Installation

Via NPM:

$ npm install --save meta-cpf

You also have to inject a validator instance into your Vue application:

src/main.js

import VeeValidate, { Validator } from 'vee-validate'

# Optional language package
import ptBR from 'vee-validate/dist/locale/pt_BR' 
Validator.addLocale(ptBR) # Optional

Vue.use(VeeValidate, {
  inject: false,
  locale: 'pt_BR',
  fieldsBagName: 'validationFields',
})

Usage

Just import it and use it as a directive:

<template>
  <div id="app">
    <meta-cpf id="id" name="name" label="CPF" v-model="cpf"></meta-cpf>
  </div>
</template>

<script>
import MetaCPF from 'meta-cpf'

export default {
  name: 'App',
  components: {
    MetaCPF,
  },
  data() {
    return {
      cpf: '',
    };
  }
}
</script>

Props

ParameterTypeRequiredDefaultDescription
classesobjectfalse{}
disabledbooleanfalsefalse
idstringtrue
labelstringtrue
maxlengthnumberfalse255
minlengthnumberfalse0
namestringtrue
patternstringfalse(.*)Regex to be applied
placeholderstringfalse
readonlybooleanfalsefalse
requiredbooleanfalsefalse
validationsobjectfalse{}Validations applied by vee-validate

Build Setup

# install dependencies
$ npm install

# serve with hot reload at localhost:8080
$ npm run dev

# build for production with minification
$ npm run build