Function default

Parameters

• props: {
      autoscroll?: boolean;
      disableErrorsHighlight?: boolean;
      getRequiredHiddenAnswer?: (
          linkId: string,
          questionnaireUrl?: string,
      ) => void | QuestionnaireValue[] | Promise<void | QuestionnaireValue[]>;
      initialResponse?: QuestionnaireResponse_2_0_0;
      onCompletedAnswer?: (
          response: QuestionnaireResponse_2_0_0,
      ) => boolean | void;
      onFullscreenRequest?: boolean;
      onMessage?: (
          message: Message,
          messagesDictionary: MessagesDictionary,
      ) => void;
      onSuccessfulSubmit?: (response: QuestionnaireResponse_2_0_0) => void;
      prefix?: boolean;
      questionnaire: Questionnaire;
      readonly?: boolean;
      submitText?: string;
      submitVariant?: OverridableStringUnion<
          "text"
          | "outlined"
          | "contained",
          ButtonPropsVariantOverrides,
      >;
      viewTitle?: boolean;
  }

  • Optionalautoscroll?: boolean

    Default true. toggle for the UI scroll to the next question on completing an answer

  • OptionaldisableErrorsHighlight?: boolean

    disable error highlighting

  • OptionalgetRequiredHiddenAnswer?: (
        linkId: string,
        questionnaireUrl?: string,
    ) => void | QuestionnaireValue[] | Promise<void | QuestionnaireValue[]>

    Optional. Default undefined. if a question is disableDisplay: hidden and required: true, this callback is called to fill the answer.

  • OptionalinitialResponse?: QuestionnaireResponse_2_0_0

    pre-filled answers, maybe from past incomplete questionnaire

  • OptionalonCompletedAnswer?: (response: QuestionnaireResponse_2_0_0) => boolean | void

    callback for when an answer is considered complete. if true is returned validates & saves the questionnaire

  • OptionalonFullscreenRequest?: boolean

    Optional. Default false. handle popup like behavier in a fullscreen mode, using AppBar context.

  • OptionalonMessage?: (message: Message, messagesDictionary: MessagesDictionary) => void

    callback for external message handling. Overwrites internal one.

  • OptionalonSuccessfulSubmit?: (response: QuestionnaireResponse_2_0_0) => void

    callback for response handling

  • Optionalprefix?: boolean

    enable prefix rendering

  • questionnaire: Questionnaire

    Prebuild questionnaire object

  • Optionalreadonly?: boolean

    Default false. disables answering the questionnaire and hides the submit button

  • OptionalsubmitText?: string

    submit button text overwrite

  • OptionalsubmitVariant?: OverridableStringUnion<
        "text"
        | "outlined"
        | "contained",
        ButtonPropsVariantOverrides,
    >

    submit button variant overwrite

  • OptionalviewTitle?: boolean

    enable title rendering