Skip to content

State Methods

getFormState()

Returns the current form-level state.

js
form.getFormState();
// { isValid, isValidating, isSubmitting, isSubmitted, isDirty, error }
PropertyTypeDescription
isValidBooleanfalse if any field has a validation error
isValidatingBooleantrue while async validators are running
isSubmittingBooleantrue between submit start and callback completion
isSubmittedBooleantrue after a successful submit
isDirtyBooleantrue if any field value differs from its default
errorStringForm-level error message (from failed submit)

getFieldState(field)

Returns state for a specific field.

js
form.getFieldState('email');
// { isValid, isDirty, isTouched, error }
PropertyTypeDescription
isValidBooleanfalse if field has a validation error
isDirtyBooleantrue if current value differs from default
isTouchedBooleantrue after the field has been blurred
errorStringValidation error message for this field

setFormState(state)

Merge state into form-level state. Mainly for internal use.

js
form.setFormState({ error: 'Something went wrong' });

setFieldState(field, state)

Merge state into a field's state. Mainly for internal use.

js
form.setFieldState('email', { isTouched: true });

touchField(field)

Mark a field as touched. Triggers validation if the validation mode includes blur. Called automatically by the x-register directive on blur.

js
form.touchField('email');

Released under the MIT License.