CodeInputFieldDefinition

@prismatic-io/spectral"types"CodeInputFieldDefinition

Hierarchy#

Index#

Properties#

Properties#

Optional collection#

collection? : InputFieldCollection

Inherited from DefaultInputFieldDefinition.collection

Collection type of the InputField


Optional comments#

comments? : undefined | string

Inherited from DefaultInputFieldDefinition.comments

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


Optional default#

default? : undefined | string

Inherited from DefaultInputFieldDefinition.default

Default value for this field.


Optional example#

example? : undefined | string

Inherited from DefaultInputFieldDefinition.example

Example valid input for this InputField.


key#

key: string

Inherited from DefaultInputFieldDefinition.key

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


label#

label: string

Inherited from DefaultInputFieldDefinition.label

Interface label of the InputField.


Optional language#

language? : undefined | string


Optional model#

model? : InputFieldChoice[] | InputFieldModelFunction

Inherited from DefaultInputFieldDefinition.model

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


Optional placeholder#

placeholder? : undefined | string

Inherited from DefaultInputFieldDefinition.placeholder

Text to show as the InputField placeholder.


Optional required#

required? : undefined | false | true

Inherited from DefaultInputFieldDefinition.required

Indicate if this InputField is required.


type#

type: "code"

Overrides DefaultInputFieldDefinition.type