API

Description:

This method will:

• Remove all events listeners from the form instance
• Lite Remove the form instance attached to the form element

Description:

Get a JS object of the form data with all user answers.
Collected data depends on the field as follow:

• checkbox ( single ): boolean
• checkbox / select ( multiple ): array of strings
• radio: value set or null
• others: set / given value

Default function supports 2 ways of creating data object:

• Use field name attribute as object key ( see example in the next column )
• Use dot-notation-like way to create a nested/complex data structure ( see demo )

The function set in options.formOptions.getFormData will be used to collect data.
See Form Options Section for details.

Attribute data-exclude-data can be used to avoid the plugin to take in consideration the field when collecting form data.

Additionally, the keyword this is bound to the Form instance.

Parameters:

• trimValues: ( Optional ) boolean indicating whether or not to trim field values when collecting data ( by default it takes the value from fieldOptions.trimValue - values from selects, checkboxes, radios and file inputs are not trimmed )

Return value:

For simple structure, an object like:

{
    name:   'Valerio',
    city:   'Milan',
    website:'http://www.valeriodipunzio.com'
}

For complex structure, see demo

Description:

Lite Fires validation for the specified field.

Then:

• Emit event fjs.field:validation ( which runs basic feedback on UI - with CSS classes )
• If field is valid and onValidationCheckAll is set to true, it will not emit fjs.field:validation for each field ( see Field Options section ) but event fjs.form:validation or fjs.group:validation based on option groups

Parameters:

• field: CSS string selector ( or node element ) for the form field ( input, select, textarea )
• fieldOptions: ( Optional ) JS object. As described in Field Options section

Return value:

A Promise that will:

• Resolve in .then(() => {}) if the field is valid.
• Reject in .catch(errors => {}) if the field is NOT valid.
  In this case an object with all errors will be passed to the catch function.

Example of returned object errors:

{
    email: true,
    missingAtChar: true
}

Description:

Fires validation for all fields that match the given selector.

Then:

• Emit event fjs.field:validation for each field *
• Emit event fjs.group:validation *
• If all the fields in the group are valid, updates the value of this.currentGroup with the selector in group.next ( values in group come from option groups, if there's no next selector, it is set to undefined )

* See Events section for details.

Parameters:

• group: ( Optional ) CSS string selector to select fields to validate. Default value is this.currentGroup
• fieldOptions: ( Optional ) JS object. As described in Field Options section

Return value:

A Promise that will:

• Resolve in .then(({canSubmit, fields, group}) => {}) if the group of fields is valid.
• Reject in .catch(({fields, group}) => {}) if the group of fields is NOT valid.

Example of returned object errors:

{
    canSubmit: false,
    fields: [...],
    group: {
        prev: Selector || undefined,
        current: Selector,
        next: Selector || undefined
    }
}

• canSubmit: ( Boolean ) true only when group.next = undefined that will tell you reached the last step/group.
• fields: ( Array ) same as returned by method validateForm but every item will have isCheckingGroup = true instead of isCheckingForm.
• group: ( Object )
  • prev: ( Selector || undefined ) based on current selector, the previous one from option groups
  • current: ( Selector ) selector of the group that has just been validated
  • next: ( Selector || undefined ) based on current selector, the next one from option groups

Description:

Fires validation for fields that already have a value set.

Then:

• Emit event fjs.field:validation for each field *

* See Events section for details.

Parameters:

• fieldOptions: ( Optional ) JS object. As described in Field Options section

Return value:

A Promise to which will be passed an array of objects ( same array as returned by method validateForm but will ONLY contain validated fields )

Description:

Lite Fires validation for the form.

If option groups is set, the validation will act like "steps" by firing method validateFieldsGroup ( validating this.currentGroup ) each time validateForm is called until last step, where, if fields are valid, the for is submitted as usual.

Then:

• Emit event fjs.field:validation for each field *
• Emit event fjs.form:validation *

* See Events section for details.

Parameters:

• fieldOptions: ( Optional ) JS object. As described in Field Options section

Return value:

A Promise that will:

• Resolve in .then(fields => {}) if all fields are valid.
• Reject in .catch(fields => {}) if one or more fields are NOT valid.

Example of returned array fields:

[
    {
        $field: $field,
        result:  false,
        errors:  {
            email: true
        },
        isCheckingForm: true
    }
]