API - español

API

Uso del plugin:

$(form).djValidator([mode],[callback])

Se debe invocar sobre formularios o campos de formularios.

Parámetro	Tipo	Descripción
mode	String	Opcional, es el modo en el que se usará el validador, si no se coloca por defecto se adjunta al evento  submit de los formularios. Otros valores posibles son: ·     ‘callback’ : Se adjunta al evento submit del formulario y llama la función pasada en el parámetro [callback] cuando todos los campos son válidos. ·     ‘validate’ : Válida un formulario como una función y devuelve true o false, se usa cuando se envía el formulario por javascript (solo se invoca sobre un formulario). ·     ‘field’ : se invoca sobre un campo de formulario para validarlo, devuelve true o false (solo se invoca sobre un campo). • ‘clean’ (v1.1.0) : Borra todos los mensajes de validación colocados en los formularios.
callback	function	Opcional, solo se especifica cuando el parámetro [mode] es ‘callback’ , es la función que debe ejecutarse cuando el formulario ya es válido, esta función debe recibir el formulario como parámetro.

Ejemplos:

Por defecto al evento submit:        
          
                 $(‘form’). djValidator();

Al evento submit, ejecuta la función cuando es válido:

                $(‘form’).djValidator(‘callback’,function($form){

                  //código

                  $form.submit();

});

Como función:

                  $(‘#myform’). djValidator(‘validate’);

Como función, valida solo un campo:    

         $(‘#myInput’). djValidator(‘field’);

Borrar mensajes de validación: 

               

         $(‘#myform’). djValidator(‘clean’);

Agregar un nuevo validador dentro de DjValidator:

      $.addDjvalidator(key,msg,callback);

Parámetro	Tipo	Descripción
key	String	Nombre de la clave a utilizar.
msg	String	Mensaje de validación.
callback	function	Función que realiza la validación, recibe 2 parámetros: [$field] : El campo a validar (objeto). [args] : Los parámetros de validación (array de strings). La función debe retornar true o false.

Ejemplo:

$.addDjValidator('even','only even numbers.',function($field,args){

                       value=parseInt($field.val());

                       max=args[1];

                       if(value%2!=1||value>max)return false;

                       return true;

      });

Cambiar el estilo CSS de los mensajes de validación:

$.setDjvalidatorStyle(style);

Parámetro	Tipo	Descripción
style	String	Contiene los estilos a aplicar en el atributo “style” de los mensajes, se debe agregar  “display:none;” para ver un efecto de FadeIn.

Ejemplo:

$.setDjValidatorStyle('display:none; text-align:center; color:white; background-color:red;');

Cambiar los mensajes de validación de DjValidator para personalizarlos o traducirlos:

$.setDjValidatorLabels(labels);

Parámetro	Tipo	Descripción
labels	Object	Contiene los nombres y los mensajes en formato json, los parámetros reemplazables están precedidos del signo $. Vea la traducción al español como referencia de los nombres de los mensajes.

Ejemplo (vea en la traducción al español el ejemplo completo):

                $.setDjValidatorLabels({

                required:'Campo requerido.',

                word_min:'Por lo menos $1 caracteres sin espacios.',

                word_between:'Entre $1 y $2 caracteres sin espacios.',

        …………………………… });



Atributos disponibles

The following attributes are used by DjValidator in the form fields:

Utilidad	Atributo	Descripción	Ejemplo
Validador a utilizar	data-dj-validator	Añade la validación al campo con la clave especificada (vea la tabla de claves de validación).	data-dj-validator="text,3,12"
Relacionar campos	data-dj-validator-group	Especifica un grupo de campos relacionados por el mismo nombre del atributo.	data-dj-validator-group=”lenguajes”
Mensaje de validación	data-dj-validator-msg	Define un mensaje de validación personalizado para el campo.	data-dj-validator-msg=”¡El nombre no es válido!”
Campo requerido (obligatorio)	required	El atributo required de HTML5 hace que el campo sea obligatorio.	required
Mensaje en campos compuestos (v1.1.0)	data-input-group	Coloca el mensaje como hijo del elemento padre del campo, usado para corregir la posición del mensaje en campos compuestos por varios elementos. El valor utilizado es irrelevante.	data-input-group="group"

Separadores reconocidos en una regla de validación


The following characters are special within the validation key (data-dj-validator attribute):

Utilidad	Caracter	Descripción	Ejemplo
Separar validadores	&	Separa varias claves de validación.	“atext,3,12&word,3,12”
Separar parámetros	,	Separa los parámetros de una clave de validación	“Text,3,50”
Separar valores de un parámetro de validación de tipo array	|	Separa los valores de un parámetro de valores múltiples.	“efile,jpg|jpeg|png|bmp”
Omitir parámetro.	*	Omite la validación del parámetro siempre y cuando la clave lo permita (ver tabla de validadores).	“atext,5,*”
Reconocer comas (v1.1.0)	°	Como la coma es un carácter especial para el validador, si se usan expresiones regulares con comas en el validador “regexp”, deben ser reemplazadas con este carácter.	"regexp,^[aeiou]{3°5}$,i"