Documentation

Mixin: FieldMixin

.fields. FieldMixin

Base mixin to be coupled to ComponentMixin for Field Classes

Methods

<static> cleanedData()

Logic Field base to get cleaned data

Returns:

Field's $value property value

Type
*

<static> selfCommit()

Common method to definitely set the updated field's values, after a successful Request to the backend has been acknowledged. $memo attribute is overridden by the current $value

Returns:

this

Type
apy.components.fields.FieldMixin

<static> selfUpdate(update, commit)

Allow one Field component to update itself.

Parameters:
Name Type Description
update Object

The update payload
commit boolean

If true, selfCommit method is invoked
Returns:

this

Type
apy.components.fields.FieldMixin

<static> setOptions(schema)

Field' schemas object setter

Parameters:
Name Type Description
schema Object

Field schema
Returns:

this

Type
apy.components.fields.FieldMixin

<static> setValue(value)

Field's value setter

Parameters:
Name Type Description
value Object

Field value
Returns:

this

Type
apy.components.fields.FieldMixin

<static> validate()

Validate each component if error, all errors are collected before being thrown.

Throws:

when validation fails

Type
apy.errors.Error

<inner> _errorMsg()

Format a validation error message

Returns:

A formatted error message

Type
string