DefaultInputFieldDefinition

@prismatic-io/spectral"types"DefaultInputFieldDefinition

Defines attributes of a InputField.

Hierarchy#

Index#

Properties#

Properties#

Optional collection#

collection? : InputFieldCollection

Collection type of the InputField


Optional comments#

comments? : undefined | string

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


Optional default#

default? : undefined | string

Default value for this field.


Optional example#

example? : undefined | string

Example valid input for this InputField.


key#

key: string

Unique identifier of the InputField. Must be unique within an Action.


label#

label: string

Interface label of the InputField.


Optional model#

model? : InputFieldChoice[] | InputFieldModelFunction

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


Optional placeholder#

placeholder? : undefined | string

Text to show as the InputField placeholder.


Optional required#

required? : undefined | false | true

Indicate if this InputField is required.


type#

type: InputFieldType

Data type the InputField will collect.