VulcanVal

External: jQuery.fn

jQuery.fn

The jQuery plugin namespace.

See:

Methods

<static> vulcanval(inspectField [, fieldName])

Invoke over instantiated elements.

Inspect the validation status of an specific field in <form>.

Parameters:
Name Type Argument Description
inspectField String

With value 'inspectField'.
fieldName String <optional>

The field name to inspect.
Returns:

It will return an error message if field is invalid, otherwise false.

Type
String | Boolean

<static> vulcanval(settings)

jQuery plugin to instantiate the validators in forms.

Defines validation functionalities over form elements.

This can be instantiated on forms or any form elements with a valid attribute name:

  • <form>
  • <input> with type different than file, submit, image, button and reset
  • <textarea>
  • <select>

Also, the plugin can be instantiated on any element with a valid input name in attribute data-vv-name which will be treated as a normal <input>. This is useful to create custom fields/entries.

Parameters:
Name Type Description
settings settings

Instance settings. This is used to configure the whole validation process.
See:
  • Also see the demos to learn how to implement this method.
Returns:

The same jQuery object.

Type
external:jQuery

<static> vulcanval(getMap)

Get the data map extracted from the <form>.

If the instance was configured with the setting settings.enableNestedMaps as true, the map returned will be nested. Otherwise it will be plain.

This method can also be used over <form> elements without being instantiated and will return a plain data map with all its inputs, selects and textareas values.

Parameters:
Name Type Description
getMap String

With value 'getMap'.
Returns:

The data map.

Type
map

<static> vulcanval(validateFieldset, fieldsetName)

Invoke over instantiated elements.

Validate visually all fields of an specific fieldset in <form>.

Parameters:
Name Type Description
validateFieldset String

With value 'validateFieldset'.
fieldsetName String

The fieldset name to validate.
Returns:

The same jQuery object.

Type
external:jQuery

<static> vulcanval(validateField, fieldName)

Invoke over instantiated elements.

Validate visually an specific field in <form>.

Parameters:
Name Type Description
validateField String

With value 'validateField'.
fieldName String

The field name to validate.
Returns:

The same jQuery object.

Type
external:jQuery

<static> vulcanval(validate)

Invoke over instantiated elements.

Validate visually all fields in <form>.

Parameters:
Name Type Description
validate String

With value 'validate'.
Returns:

The same jQuery object.

Type
external:jQuery

<static> vulcanval(resetFieldset, fieldsetName)

Invoke over instantiated elements.

Reset all fields in fieldset validation state. This removes all current error states in those fields.

Parameters:
Name Type Description
resetFieldset String

With value 'resetFieldset'.
fieldsetName String

Fieldset name to reset.
Returns:

The same jQuery object.

Type
external:jQuery

<static> vulcanval(inspect)

Invoke over instantiated elements.

Inspect the validation status of the <form>.

Parameters:
Name Type Description
inspect String

With value 'inspect'.
Returns:

A plain object with keys as field names and values with error messages if they have. If form is valid, false will be returned.

Type
Object | String | Boolean

<static> vulcanval(inspectFieldset, fieldsetName)

Invoke over instantiated elements.

Inspect the validation status of all fields in fieldset in the <form>.

Parameters:
Name Type Description
inspectFieldset String

With value 'inspectFieldset'.
fieldsetName String

The fieldset name to inspect.
Returns:

A plain object with keys as field names and values with error messages if they have. If fieldset is valid, false will be returned.

Type
Object | String | Boolean

<static> vulcanval(resetField, fieldName)

Invoke over instantiated elements.

Reset specific field validation state. This removes all current error states from field.

Parameters:
Name Type Description
resetField String

With value 'resetField'.
fieldName String

The name of the field.
Returns:

The same jQuery object.

Type
external:jQuery

<static> vulcanval(reset)

Invoke over instantiated elements.

Reset the <form> validation state. This removes all current error states.

Parameters:
Name Type Description
reset String

With value 'reset'.
Returns:

The same jQuery object.

Type
external:jQuery