Skip to main content

CodeInputFieldDefinition

@prismatic-io/spectral"types/Inputs"CodeInputFieldDefinition

Hierarchy#

Index#

Properties#

Properties#

Optional collection#

collection? : InputFieldCollection

Inherited from DefaultInputFieldDefinition.collection

Defined in types/Inputs.ts:16

Collection type of the InputField


Optional comments#

comments? : undefined | string

Inherited from DefaultInputFieldDefinition.comments

Defined in types/Inputs.ts:22

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


Optional default#

default? : undefined | string

Inherited from DefaultInputFieldDefinition.default

Defined in types/Inputs.ts:20

Default value for this field.


Optional example#

example? : undefined | string

Inherited from DefaultInputFieldDefinition.example

Defined in types/Inputs.ts:24

Example valid input for this InputField.


label#

label: string

Inherited from DefaultInputFieldDefinition.label

Defined in types/Inputs.ts:12

Interface label of the InputField.


Optional language#

language? : undefined | string

Defined in types/Inputs.ts:33


Optional model#

model? : InputFieldChoice[] | InputFieldModelFunction

Inherited from DefaultInputFieldDefinition.model

Defined in types/Inputs.ts:28

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


Optional placeholder#

placeholder? : undefined | string

Inherited from DefaultInputFieldDefinition.placeholder

Defined in types/Inputs.ts:18

Text to show as the InputField placeholder.


Optional required#

required? : undefined | false | true

Inherited from DefaultInputFieldDefinition.required

Defined in types/Inputs.ts:26

Indicate if this InputField is required.


type#

type: "code"

Overrides DefaultInputFieldDefinition.type

Defined in types/Inputs.ts:32