Interface QuestionConfigs<Custom>

interface QuestionConfigs<Custom> {
    choices?: ChoiceConfigs<Custom>[];
    custom?: Custom;
    defaultAnswer?: any;
    defaultDisabled?: boolean;
    disabledOnSelected?: ItemAbledOnSelected;
    enabledOnSelected?: ItemAbledOnSelected;
    id?: string;
    type: QuestionType;
    validators?: string[];
}

Type Parameters

  • Custom = any

Hierarchy

  • ItemConfigs<Custom>
    • QuestionConfigs

Properties

choices? custom? defaultAnswer? defaultDisabled? disabledOnSelected? enabledOnSelected? id? type validators?

Properties

Optionalchoices

choices?: ChoiceConfigs<Custom>[]

Choices for questions with choice or choices as [[type]].

Optionalcustom

custom?: Custom

Any values that help you determine on how to render the frontend UI or how to perform validation.

OptionaldefaultAnswer

defaultAnswer?: any

Default answer.

Questions with any as [[type]] accept any as answer.

Questions with choice as [[type]] accept any as answer.

Questions with choices as [[type]] accept any[] as answer.

OptionaldefaultDisabled

defaultDisabled?: boolean

Whether or not this item is disabled by default.

OptionaldisabledOnSelected

disabledOnSelected?: ItemAbledOnSelected

A list of choice id.

This item will be disabled if the requirement is fulfilled.

OptionalenabledOnSelected

enabledOnSelected?: ItemAbledOnSelected

A list of choice id.

This item will be enabled if the requirement is fulfilled.

Optionalid

id?: string

Item id.

It should be unique throughout the entire form.

It will be auto generated if you leave it falsy.

type

type: QuestionType

Question type.

Questions with any as [[type]] accept any as answer. You shouldn't have to specify [[choices]] for this question.

Questions with choice as [[type]] accept any as answer. You should specify [[choices]] for this question. Usually radio button group or dropdown select will be used for this type of questions.

Questions with choices as [[type]] accept any[] as answer. You should specify [[choices]] for this question. Usually checkbox group or select with multiple mode turned on will be used for this type of questions.

Optionalvalidators

validators?: string[]

Names of the validators to be used for validation when answer of this question is changed.

Validators will be executed in sequence of their positions in the list.

Settings

Member Visibility

On This Page

Properties