AboutSupportDeveloper GuideVersion 22.3.18

Interface CheckboxGroupField<W>

The base type for form fields.

interface CheckboxGroupField<W> {
    helperText?: string;
    key: string;
    label?: string;
    type: "checkboxGroup";
    validation?: Record<string, any>;
    value?: string[];
    widget: W;
}

Type Parameters

Hierarchy (view full)

  • BaseField<"checkboxGroup", string[]>
    • CheckboxGroupField

Properties

helperText? key label? type validation? value? widget

Properties

OptionalhelperText

helperText?: string

Helper text.

key

key: string

The property key that this field value will appear in the returned NotificationFormSubmittedEvent.form|form object.

Optionallabel

label?: string

Input label.

type

type

Field data type.

Optionalvalidation

validation?: Record<string, any>

Validation rules used to validate user input.

Optionalvalue

value?: string[]

Default value for field, and where it will be written to

widget

widget: W

Settings

On This Page

Properties