Form Generator · Basic usage

Basic usage

import FormGenerator, { FormTypes } from '../../components/FormGenerator';
import { householdQuestionRenderers } from '../HouseholdAccounts/formQuestions/questionRenderers';

const formGenerator = new FormGenerator(container, {
  questions: stepsFromApi,       // often response.Steps / response.steps
  totalSteps: 3,
  formType: FormTypes.StepForm,
  themeColor: 'color-lta-blue',
  isBackButtonEnabled: true,
  // Only needed when the Steps API uses module-owned questionTypes:
  questionRenderers: householdQuestionRenderers,
  submitButton: {
    title: 'Submit',
    alwaysVisible: false
  }
});

formGenerator.onChange((answers) => { /* … */ });
formGenerator.onStepChange((step) => { /* … */ });
formGenerator.onSubmit((answers, value) => { /* … */ });

Real example: Youth Starter Offer passes questionRenderers: householdQuestionRenderers so householdMemberList resolves.