Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QuestionnaireControlProps

Props for a QuestionnaireControl.

Hierarchy

Properties

Properties

Optional apl

apl: QuestionnaireControlAPLProps

Props to customize the APL generated by this control.

Optional dialog

dialog: undefined | object

Props to configure dialog policy.

id

id: string

Unique identifier for control instance

Optional inputHandling

inputHandling: QuestionnaireControlInputHandlingProps

Props to configure input handling.

Optional interactionModel

interactionModel: QuestionnaireControlInteractionModelProps

Props to customize the relationship between the control and the interaction model.

Optional prompts

prompts: QuestionnaireControlPromptProps

Props to customize the prompt fragments that will be added by this.renderAct().

questionnaireData

questionnaireData: QuestionnaireContent | function

Content for the questionnaire.

Optional reprompts

reprompts: QuestionnaireControlPromptProps

Props to customize the reprompt fragments that will be added by this.renderAct().

Optional required

required: boolean | function

Determines if the Control must obtain a value.

If true:

  • the Control report isReady() = false if no value has been obtained.
  • the control will take the initiative when given the opportunity.

Optional valid

valid: StateValidationFunction<QuestionnaireControlState>

Determine if the questionnaire is considered valid, i.e. has no input errors and is considered 'sufficiently complete' for the purposes of the Skill.

Default: true, i.e. no validation and user can 'be done' whenever they wish.

Usage:

  • Validation functions return either true or a ValidationResult to describe what validation failed.