Skip to content

Latest commit

 

History

History
180 lines (132 loc) · 5.09 KB

readme.md

File metadata and controls

180 lines (132 loc) · 5.09 KB

jQuery.SDQ

Es un plugin de jQuery Open Source para validar diversos tipos de documentos y darle formato a los campos de entradas.

Por ejemplo, puedes darle el formato debido a un campo haciendo lo siguiente:

var cedula = $("#CampoCedula").SDQ('cedula');

y luego, cuando vas a someter tu formulario puedes proceder a hacer tus validaciones de la siguiente manera:

if (!cedula.validar()) {
	alert ('El numero de cedula es invalido');
	return false;
}

Los tipos de documentos que se manejan son:

  • Cedula de identidad y electoral - JCE
  • Registro Nacional de Contribuyente (RNC) - DGII {acaba de ser agregado - beta}
  • Numero de comprobante fiscal (NCF) - DGII {acaba de ser agregado - beta}
  • Numero de Seguridad Social (NSS) - TSS {pendiente}

##¿Como incluirlo en su proyecto?

Puedes bajar la ultima versión de esta libreria, disponible en https://raw.github.com/hminaya/SDQ/master/lib/jquery.sdq.js e incluirlo junto con sus otros scripts. Recuerda que debes tener incluido jQuery para poder utilizar esta libreria.

##API - Cedula

$.fn.SDQ('cedula');

Le da formato a un campo para introducir una cedula:

  • Solo permite que se puedan introducir numeros
  • Maneja el paste para evitar chars invalidos
  • Solo permite longitud de 11

Ejemplo:

$('#campoCedula').SDQ('cedula');

$.SDQ.validarCedula(numero);

Valida si la información recibida corresponde a un numero de cedula:

  • Compara contra el algoritmo de LUHN utilizando mod 10
  • Maneja un listado de cedulas que fueron emitidas por la JCE, pero que no cumplen con el algoritmo anterior
  • Solo puede contener numeros
  • Valida la longitud

Ejemplo:

$.SDQ.validarCedula('00113918315'); // => False

Alternativa

otra forma de validar un input de cedula es de la siguiente manera:

var cedula = $('#campoCedula').SDQ('cedula');
cedula.validar() // => Toma el valor del campo y se la pasa al metodo $.SDQ.validarCedula()

##API - RNC

$.fn.SDQ('rnc');

Le da formato a un campo para introducir un RNC:

  • Solo permite que se puedan introducir numeros
  • Maneja el paste para evitar chars invalidos
  • Solo permite longitud de 9

Ejemplo:

$('#campoRNC').SDQ('rnc');

$.SDQ.validarRNC(numero);

Valida si la información recibida corresponde a un RNC:

  • Compara contra el algoritmo
  • Maneja un listado de RNCs que fueron emitidos por la DGII, pero que no cumplen con el algoritmo anterior //TODO: Pendiente
  • Solo puede contener numeros
  • Valida la longitud

Ejemplo:

$.SDQ.validarRNC('A234567XX'); // => False

Alternativa

otra forma de validar un input de rnc es de la siguiente manera:

var rnc = $('#campoRNC').SDQ('rnc');
rnc.validar() // => Toma el valor del campo y se la pasa al metodo $.SDQ.validarRNC()

##API - NCF

$.fn.SDQ('ncf');

Le da formato a un campo para introducir un NCF:

  • Permite la entrada de datos de acuerdo a la estructura de un NCF (pendiente)
  • Maneja el paste para evitar chars invalidos
  • Controla la longitud (pendiente)

Ejemplo:

$('#campoNCF').SDQ('ncf');

$.SDQ.validarNCF(numero);

Valida si la información recibida corresponde a un NCF:

  • Compara contra el algoritmo (pendiente)
  • Solo puede contener numeros y letras de acuerdo a las especificaciones
  • Valida la longitud

Ejemplo:

$.SDQ.validarNCF('A999999999999999999'); // => False

Alternativa

otra forma de validar un input de ncf es de la siguiente manera:

var ncf = $('#campoNCF').SDQ('ncf');
ncf.validar() // => Toma el valor del campo y se la pasa al metodo $.SDQ.validarNCF()

##API - NSS

$.fn.SDQ('nss');

Le da formato a un campo para introducir un NSS:

  • Solo permite que se puedan introducir numeros
  • Maneja el paste para evitar chars invalidos
  • Solo permite longitud de XX //TODO: Pendiente

Ejemplo:

$('#campoNSS').SDQ('nss');

$.SDQ.validarNSS(numero);

Valida si la información recibida corresponde a un NSS:

  • Compara contra el algoritmo XX // TODO: Pendiente
  • Maneja un listado de NSS que fueron emitidos por la TSS, pero que no cumplen con el algoritmo anterior //TODO: Pendiente
  • Solo puede contener numeros
  • Valida la longitud //TODO: Pendiente

Ejemplo:

$.SDQ.validarNSS('A234567XX'); // => False

Alternativa

otra forma de validar un input de nss es de la siguiente manera:

var nss = $('#campoNSS').SDQ('nss');
nss.validar() // => Toma el valor del campo y se la pasa al metodo $.SDQ.validarNSS()

##¿Como contribuir? Si quieres contribuir en este proyecto puedes comenzar con uno de los issues pendientes o puedes proponer tus propias ideas. Antes de hacer tu pull request pasa tu codigo por JSLint.

Actualmente estamos trabajando en este proyecto: