Formularios
SDK para generar formularios y encuestas generados en su cuenta mediante Javascript.
La documentación y recursos necesarios para utilizar Forms SDK está estrictamente restringido para uso de clientes de Videsk. Nos reservamos el derecho de restringir su acceso y uso, si detectamos un uso inadecuado.
Instalación
Para utilizar Forms SDK podrás instarlo mediante nuestro CDN.
Modo de uso
De forma simple puedes instanciar Forms. Posteriormente deberás definir oyentes de eventos y adjuntar métodos a un botón personalizado.
Propiedades
data
data
Con esta propiedad podrás obtener el formulario con sus campos sin necesidad de llamar al método submit
.
Métodos
Ya instanciado el SDK podrás acceder a los siguientes métodos:
on
on
Este método tiene como objetivo que definas un oyente cuando un evento ocurra. Los dos argumentos que recibe son:
event
: nombre del eventocallback
: función que se ejecutará al ocurrir el evento
render
render
Con este método renderizas los campos del formulario. Los dos argumentos que recibe son:
form
: array de campos obtenido por SDK o APIreadonly
: define si son de lectura o escritura, por defectofalse
submit
Este método permite enviar el formulario activando la validación de campos y posteriormente el evento submit
.
Puedes obtener los valores de los campos y su validez mediante un valor retorno de tipo object
que contiene data
(array) y valid
(boolean).
set/update
set/update
Con este método podrás actualizar el valor de un campo en específico mediante sus propiedades como: name
, label
, type
, value
y _id
. Este método recibe cuatro argumento:
name
: valor con el cual se va a buscar el campovalue
: valor a insertar en el campoproperty
: propiedad a modificar, por defecto esvalue
key
: nombre de la propiedad a buscar, por defecto esname
Disponemos de un método envoltorio que puede facilitar el uso.
destroy
destroy
Este método elimina por completo el nodo HTML donde se renderizó.
Eventos
Los eventos disponibles son submit
, ready
, updated
, error
.
submit
submit
Este evento se produce una vez que se ejecuta el método submit()
. El único argumento callback es un object
compuesto de:
valid
: boolean que indica si todos los campos son válidos
Captcha no es opcional para formularios base o de contacto, excepto para encuestas.
ready
ready
Con este evento podrás oír cuando el formulario ha sido renderizado exitosamente. No contiene argumento callback.
updated
updated
Con este evento podrás escuchar la actualización del valor de un campo. El argumento callback es un object
compuesto de:
_id
: corresponde el id del campo actualizado comostring
.value
: corresponde al valor del campo, el cual puede serstring
,boolean
,array
onumber
.
error
error
Con este evento podrás escuchar errores que solo podrían surgir al momento de renderizar el formulario. Contiene tres argumentos compuestos de:
name
: nombre del error comostring
code
: código del error los puede ser400
y403
message
: mensaje legible sobre el error
Ejemplo
Última actualización
¿Te fue útil?