Interface ChoiceConfigs<Custom>

interface ChoiceConfigs<Custom> {
    custom?: Custom;
    defaultDisabled?: boolean;
    disabledOnSelected?: ItemAbledOnSelected;
    enabledOnSelected?: ItemAbledOnSelected;
    id?: string;
    onSelected?: ChoiceOnSelected;
    value?: any;
}

Type Parameters

  • Custom = any

Hierarchy

  • ItemConfigs<Custom>
    • ChoiceConfigs

Properties

custom? defaultDisabled? disabledOnSelected? enabledOnSelected? id? onSelected? value?

Properties

Optionalcustom

custom?: Custom

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

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.

OptionalonSelected

onSelected?: ChoiceOnSelected

Deprecated

use enabledOnSelected and disabledOnSelected on the target items instead.

Actions to be performed when this choice is toggled.

Optionalvalue

value?: any

Value of this choice. It will be used as answer of the question.

Using primitive type like string or number is recommended due to the limitation in comparing complex value.

Id will be used as value if you leave it undefined.

Settings

Member Visibility

On This Page

Properties