React MutableRefObject of default model values.
React MutableRefObject of errors.
React MutableRefObject of registered elements.
React MutableRefObject indicating if form/Komo is mounted.
React MutableRefObject of active model values.
React MutableRefObject indicating if form/Komo is mounted.
Komo initialization options.
React MutableRefObject of native validation AST schema configurations.
Object containing active state of the form.
React MutableRefObject indicating the form submission count.
React MutableRefObject indicating if form has submitted.
React MutableRefObject indicating if form is submitting.
List of unregistered element names.
The normalized validation interface used to validate model and model paths.
Clears all dirty field/elements.
Clears all errors from error model.
Clears all touched field/elements.
Gets the default value at a given model path or all default model values.
the path to get the default for.
Finds field by element used here for normalization.
a registered element.
Finds a field/element by name or path.
the name or path used to lookup element.
when true will return all matching names such as in a radio group.
Finds a field/element by name or path.
the name or path used to lookup element.
Gets the model value at the specified path.
the path to get model at.
Gets the entire model.
Checks if model contains prop at path.
the path to check if exists.
Initializes and normalizes the schema.
Checks if field/element is dirty.
the name of the form field/element.
Compares value to default value return if has changed and is dirty.
a form element name.
the value to be compared to default.
the default data in model.
Checks if field/element is touched.
the name of the form field/element.
Indicates if form supports validation.
Inspect element and checks if validation blur is enabled.
the element to be inspected.
Inspect element and checks if validation change is enabled looking up by field name.
the element name to be looked up.
Inspect element and checks if validation change is enabled.
the element to be inspected.
Inspect element and checks if validation change is enabled looking up by field name.
the element name to be looked up.
Removes form field/element as dirty.
Removes error for the specified field/element by name.
the name of the field/element to remove error for.
Removes form field/element as touched.
Triggers rerendering of the form.
the status state calling the render.
Sets the default value at the specified. path.
the path to be set.
the value to be set at path.
Sets the default model.
the model complete model to be set.
whether to merge/extend with existing model.
Sets form field/element as dirty.
the name of the form field/element.
Sets field/element error.
the field/element name to set error for.
the error value to be set.
Sets complete error model.
the error model to be set.
whether to extend/merge with existing errors.
Sets model value at the specified path.
the path to set value at.
the value to be sat at path.
Sets the complete model.
the model to be set.
when true extends/merges with existing model.
Sets form field/element as touched.
the name of the form field/element.
Updaetes default values from synchronizing with model and elements.
the defaults to sync.
indicates defaults are reinitializing.
Unregisters an element by instance.
the element to be unregistered.
Unregisters an element by name or path.
the element name to lookup to be unregistered.
Validates the specified model.
the yup validation options if any to pass.
Validates model for the specified element.
the element to be validated.
the yup validation options if any to pass.
Validates model for the specified element.
the name of the element to lookup and validate.
the yup validation options if any to pass.
Generated using TypeDoc
The base API interface used by form field elements and form submit, reset handlers.