Skip to main content



Defines attributes of a InputField.





Optional collection#

collection? : InputFieldCollection

Defined in types/Inputs.ts:16

Collection type of the InputField

Optional comments#

comments? : undefined | string

Defined in types/Inputs.ts:22

Additional text to give guidance to the user configuring the InputField.

Optional default#

default? : undefined | string

Defined in types/Inputs.ts:20

Default value for this field.

Optional example#

example? : undefined | string

Defined in types/Inputs.ts:24

Example valid input for this InputField.


label: string

Defined in types/Inputs.ts:12

Interface label of the InputField.

Optional model#

model? : InputFieldChoice[] | InputFieldModelFunction

Defined in types/Inputs.ts:28

Dictates possible choices or a function to generate choices for the InputField.

Optional placeholder#

placeholder? : undefined | string

Defined in types/Inputs.ts:18

Text to show as the InputField placeholder.

Optional required#

required? : undefined | false | true

Defined in types/Inputs.ts:26

Indicate if this InputField is required.


type: InputFieldType

Defined in types/Inputs.ts:14

Data type the InputField will collect.