Skip to content

Latest commit

 

History

History
211 lines (149 loc) · 7.3 KB

DOCS.md

File metadata and controls

211 lines (149 loc) · 7.3 KB

Functions

isForm(value)boolean

Indicates if passed value is Form object.

isFormFieldUpdated(ff1, ff2)boolean

Indicates if FormField's value or error has changed.

isFormField(field)boolean

Indicates if passed param is FormField object.

createFormField(val, [validators], [noValidate])FormField

Creates FormField object.

createPasswordFormField(val, [validators], [noValidate])PwdField

Creates PwdField object.

formFieldsToValues(form)Object

Converts all FormFields in passed object into {[key]: value}

setNoValidate(key, field)FormField

Toggles noValidate on FormField.

changeFormFieldsValidation(form)Object

Toggles noValidate on Form

changeFormValue(formToChange, fieldName, value)Object

Changes FormField value.

formHasChanged(formToCheck)boolean

Indicated if any value in form is different than initial value.

formFieldHasChanged(formField)boolean

Indicated if FormField value is different than initial value.

formHasError(formToCheck)boolean

Indicated if form has error.

validateForm(formToValidate)Object

Validates FormFields in form.

validateFormField(formField)FormField

Validates FormField.

validateOneFormField(formToValidate, fieldName)Object

Validates one specified FormField in form.

isForm(value) ⇒ boolean

Indicates if passed value is Form object.

Kind: global function

Param Type Description
value any

Value to check.

isFormFieldUpdated(ff1, ff2) ⇒ boolean

Indicates if FormField's value or error has changed.

Kind: global function

Param Type Description
ff1 FormField

First FormField.

ff2 FormField

Second FormField.

isFormField(field) ⇒ boolean

Indicates if passed param is FormField object.

Kind: global function

Param Type Description
field any

Field to check.

createFormField(val, [validators], [noValidate]) ⇒ FormField

Creates FormField object.

Kind: global function

Param Type Description
val T

Initial value for FormField.

[validators] Array.<(FormFieldValidatorFn.<T>|FormFieldValidatorFnWithParamsObject.<T>)>

Array of validators.

[noValidate] boolean

If true, FormField will not be validated.

createPasswordFormField(val, [validators], [noValidate]) ⇒ PwdField

Creates PwdField object.

Kind: global function

Param Type Description
val string

Initial value for PwdField.

[validators] Array.<(FormFieldValidatorFn.<string>|FormFieldValidatorFnWithParamsObject.<string>)>

Array of validators.

[noValidate] boolean

If true, FormField will not be validated.

formFieldsToValues(form) ⇒ Object

Converts all FormFields in passed object into {[key]: value}

Kind: global function

Param Type Description
form Object

Form.

setNoValidate(key, field) ⇒ FormField

Toggles noValidate on FormField.

Kind: global function

Param Type Description
key string

Key of FormField.

field FormField

FormField.

fieldsToSetValidation. Object

changeFormFieldsValidation(form) ⇒ Object

Toggles noValidate on Form

Kind: global function

Param Type Description
form Object

Form with FormFields.

fieldsToSetValidation. Object

changeFormValue(formToChange, fieldName, value) ⇒ Object

Changes FormField value.

Kind: global function

Param Type Description
formToChange string

Form.

fieldName string

Key of FormField in form.

value GenericTypeOfFormField.<U>

Value to change

formHasChanged(formToCheck) ⇒ boolean

Indicated if any value in form is different than initial value.

Kind: global function

Param Type Description
formToCheck Object

Form.

formFieldHasChanged(formField) ⇒ boolean

Indicated if FormField value is different than initial value.

Kind: global function

Param Type Description
formField FormField

FormField.

formHasError(formToCheck) ⇒ boolean

Indicated if form has error.

Kind: global function

Param Type Description
formToCheck Object

Form.

validateForm(formToValidate) ⇒ Object

Validates FormFields in form.

Kind: global function

Param Type Description
formToValidate Object

Form.

validateFormField(formField) ⇒ FormField

Validates FormField.

Kind: global function

Param Type Description
formField FormField

FormField.

validateOneFormField(formToValidate, fieldName) ⇒ Object

Validates one specified FormField in form.

Kind: global function

Param Type Description
formToValidate Object

Form.

fieldName string

Key of FormField to validate.