A field consisting of a drop down with multiple choices.

Constructors

Properties

defaultValues: string[]

The values selected by default. Those values will be submitted unless the customer modifies them.

dependentFields: DependentField[]

A list of other fields to make visible based on the value filled in for this field.

description?: string

Additional text helping the customer to complete the field.

fieldType: Dropdown

Determines how the field will be displayed and validated.

hidden: boolean

Whether a field should be hidden or not. Hidden fields won't appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in.

label: string

The main label for the form field.

name: string

The identifier of the field. In combination with the object type ID, it must be unique.

objectTypeId: string

A unique ID for this field's CRM object type. For example a CONTACT field will have the object type ID 0-1.

The list of available choices for this field.

placeholder?: string

The prompt text showing when the field isn't filled in.

required: boolean

Whether a value for this field is required when submitting the form.

attributeTypeMap: {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[] = ...
discriminator: undefined | string = undefined

Methods

  • Returns {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]