Function default

Parameters

• props: {
      action?: QuestionnaireActionType;
      autoscroll?: boolean;
      channelOwner?: SHA256IdHash<Person>;
      getRequiredHiddenAnswer?: (
          linkId: string,
          questionnaireUrl?: string,
      ) => void | QuestionnaireValue[] | Promise<void | QuestionnaireValue[]>;
      language?: string;
      onCompletedAnswer?: (
          response: QuestionnaireResponse_2_0_0,
      ) => boolean | void;
      onFullscreenRequest?: boolean;
      onMessage?: (
          message: Message,
          messagesDictionary: MessagesDictionary,
      ) => void;
      prefix?: boolean;
      questionnaireModel: QuestionnaireModel;
      questionnaireName?: string;
      questionnaireResponse?: QuestionnaireResponse_2_0_0;
      redirectAfterSubmit?: (
          responses: SHA256Hash<QuestionnaireResponses_2_0_0>,
          qResponse: QuestionnaireResponse_2_0_0,
      ) => void | Promise<void>;
      responseId?: string;
      saveQuestionnaireProgress?: boolean;
      viewTitle?: boolean;
  }

  • Optionalaction?: QuestionnaireActionType

    any GET params overwrites this. Show questionnaire with specified action type

  • Optionalautoscroll?: boolean

    Default true. flag to toggle the UI scroll to the next question

  • OptionalchannelOwner?: SHA256IdHash<Person>

  • 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.

  • Optionallanguage?: string

    overwrites any GET params to show questionnaire with specified language

  • 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 message handling outside one.ui

  • Optionalprefix?: boolean

    enable prefix rendering

  • questionnaireModel: QuestionnaireModel

  • OptionalquestionnaireName?: string

    overwrites any GET params to show a specific questionnaire by name

  • OptionalquestionnaireResponse?: QuestionnaireResponse_2_0_0

    questionnaire response outside of model. When provided force sets action to 'view' and ignores GET params.

  • OptionalredirectAfterSubmit?: (
        responses: SHA256Hash<QuestionnaireResponses_2_0_0>,
        qResponse: QuestionnaireResponse_2_0_0,
    ) => void | Promise<void>

    post-processed questionnaire callback

  • OptionalresponseId?: string

    id of an incomplete questionnaire, so we can load and show pre-filled answers

  • OptionalsaveQuestionnaireProgress?: boolean

    Default false. flag saving incomplete questionnaire response in model

  • OptionalviewTitle?: boolean

    enable title rendering