Class Form<Custom>

Construct a form.

Throws

if configs is invalid

Do a final round of validation and get the validated answers.

This method will not update render instructions. It is more for when you need to make sure that the form is really clean and get the final validated answers for further usage, e.g. calling API, store into database, etc.

Clear answers of the entire form.

Clear answer of a question.

Clear answers of the entire group.

Get sanitized configs of this form.

You can persist it and use it to reconstruct the form later.

Get current answer of a question. The answer is unvalidated.

Get current answers. The answers are unvalidated.

You can persist it and use it with [[importAnswers]] method to restore the answers later.

Get error of a question.

If the question hasn't gone through validation, it will not have error, even if its answer is currently invalid.

Get errors.

Questions which didn't go through validation will not have errors, even if their answers are currently invalid.

You can use [[validate]] method to validate all answers in the form.

Get a set of instructions to be used for rendering frontend UI.

Get validated answer of a question.

If the question is disabled or it's answer is not valid, it's answer will be set to undefined.

Get validated answers.

If a question is disabled or it's answer is not valid, it's answer will be set to undefined.

You can persist it and use it with [[importAnswers]] method to restore the answers later.

Import answers to the form.

Check whether form is clean.

Form will always be clean if it didn't go through any validation, even if there are invalid answers in the form.

You can use [[validate]] method to validate all answers in the form.

Check whether form is currently being validated.

The result might be true if you have async validator and the validation is not completed yet.

Reset answers of the entire form to default answers.

Reset answer of a question to default answer.

Reset answers of the entire group to default answers.

Select invididual choice.

This method can be used by questions with choice or choices as [[type]] only.

Set answer of a question.

Set answer of a question with any as [[type]].

Set answer of a question with choice as [[type]].

Set answers of a question with choices as [[type]].

Validate the entire form.

Validate configs.

The following validations will be conducted:

• Form is not without any groups or questions
• No duplicated ids within the form
• No groups without questions
• No questions with choice or choices as type without choices
• No duplicated choice values within a question
• No circular choices' onSelected configs

Put strict as true to validate the following:

• No unrecognized ids in choices' onSelected configs